tibasSpace_BrowseEvents()

Returns a browser for the space to iterate through all the events that match the filter.

Declaration

tibas_status tibasSpace_BrowseEvents
(tibasSpace             space,
tibasEventBrowser*      eventBrowser,
tibasEventBrowserDef    browserDef,
const char*             filter)

Parameters

Parameter Description
space The TIBCO ActiveSpaces entity on which the function is invoked.
eventBrowser The browser returned by the function.
browserDef The browser definition can be used to set timeout values and distribution or time scopes
filter The filter criteria.

Remarks

Use the tibaSpace_BrowseEvents() function to create an event browser on a specified space.

On each iteration, the browser will return an event for the next tuple. Events represent a put, take, seed, unseed, or expire event

Before you call this function, create an eventBrowserDef object by calling the tibasEventBrowserDef_Create() or tibasEventBrowserDef_CreateEx() function and define the attributes of the event browser. You can do this directly when you specify the arguments for the tibasEventBrowserDef_CreateEx() function, or by calling the EventBrowserDef functions, which let you specify the distribution scope and time scope plus a timeout value for the event browser.

You can use the filter parameter to specify a filter that limits the events returned by the event browser.

After you create the event browser, use the tibasEventBrowser_Next() function to iteratively return the next matching event in the space’s event stream.

See Also

tibasEventBrowserDef_Create(), tibasEventBrowserDef_CreateEx(), tibasEventBrowserDef_SetDistributionScope(), tibasEventBrowserDef_GetTimeScope(), tibasEventBrowserDef_SetTimeout(), tibasEventBrowser_Next(), tibasMetaspace_BrowseEvents()