tibasSpace_Browse()

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

On each iteration, the browser will apply an operation on the next tuple. The operation is either a get, take, or lock depending on the browser type.

Declaration

tibas_status tibasSpace_Browse(
    tibasSpace space,
    tibasBrowser* browser,
    tibas_browserType browserType,
    tibasBrowserDef browserDef,
    const char* filter)

Parameters

Parameter Description
space The TIBCO ActiveSpaces entity on which the function is invoked.
browser Returns a browser object.
browserType Can be TIBAS_BROWSER_GET, TIBAS_BROWSER_TAKE, or TIBAS_BROWSER_LOCK.
browserDef The browser definition can be used to set timeout values and distribution or time scopes
filter The filter criteria.

Remarks

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

The browserType parameter specifies the type of browser, which can be one of the following:

  • TIBAS_BROWSER_GET - Specifies a Get Browser, which retrieves the next tuple in a series of tuples.
  • TIBAS_BROWSER_TAKE - Specifies a Take Browser, which retrieves the next tuple in a series of tuples and consumes it.
  • TIBAS_BROWSER_LOCK - Specifies a Lock Browser, which retrieves the next tuple in a series of tuples and locks it.

Before you call this function, create a BrowserDef object by calling the tibasBrowserDef_Create() or tibasBrowserDef_CreateEx() function and define the attributes of the event browser. You can do this directly when you specify the arguments for the tibasBrowserDef_CreateEx() function, or by calling the BrowserDef functions, which let you specify the distribution scope and time scope plus a timeout value for the 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() to iteratively return the next matching event in the space’s event stream.