tibasMetaspace_BrowseEvents()

Creates an event browser on the specified space.May cause the space to be automatically joined with a distribution role of TIBAS_DISTRIBUTION_ROLE_LEECH if not already joined.

Declaration

tibas_status tibasMetaspace_BrowseEvents(
    tibasMetaspace       metaspace,
    tibasEventBrowser*   eventBrowser,
    const char*          spaceName,
    tibasEventBrowserDef eventBrowserDef,
    const char*          filter)

Purpose

Parameters

Parameter Description
metaspace The TIBCO ActiveSpaces entity on which the function is invoked.
browser The returned event browser object.
spaceName The name of the space to browse.
browserDef A browser definition object.
filter A string containing a filter to apply to the event browser or NULL.

Remarks

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

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()