tibasBrowserDef_SetTimeout()

Sets the timeout value for a specified browserDef (browser).

Declaration

tibas_status tibasBrowserDef_SetTimeout
(tibasBrowserDef browserDef,
tibas_long       timeout)

Parameters

Parameter Description
browserDef The TIBCO ActiveSpaces entity on which the function is invoked.
timeout The time in milliseconds or TIBAS_WAIT_FOREVER or TIBAS_NO_WAIT.

Remarks

Use the tibasBrowserDef_SetTimeout() function to specify a timeout value for a specified browserDef (browser).

The timeout is the amount of time for which a space browser'stibasBrowser_Next() function can block while waiting for something new in the space to execute a tibasBrowser_Next() on. If there is still nothing new for the browser to perform a next() operation on at the end of the timeout, thetibasBrowser_Next() function returns null.

You can specify one of the following with the timeout parameter:

The timeout value in milliseconds.

TIBAS_WAIT_FOREVER
Specifies that the browser will not time out.
TIBAS_NO_WAIT
Specifies that the browser will not wait before executing another tibasBrowser_Next() operation.
Note: The browser’s timeout value is ignored when the browser’s time scope is set to TIBAS_TIME_SCOPE_SNAPSHOT. In this case, any invocation of the tibasBrowser_Next() function on the browser once all of the tuples in the snapshot have been iterated through immediately returns NULL.

See Also

tibasBrowserDef_Create(), tibasBrowserDef_CreateEx(), tibasBrowserDef_GetTimeout()