Browser Class

Browser Class

Browsers are used to retrieve and work on multiple SpaceEntries, and are sometimes referred to as 'Entry Browsers' (as opposed to 'Event Browsers').

Inheritance Hierarchy

SystemObject
Com.Tibco.As.Space.BrowserBrowser

Namespace: Com.Tibco.As.Space.Browser
Assembly: TIBCO.ActiveSpaces.Common (in TIBCO.ActiveSpaces.Common.dll) Version: 2.0.0.0 (2.1.5.12)

Syntax

C++

Copy

public abstract class Browser : IEnumerator<Tuple>, 
	IDisposable, IEnumerator, IEnumerable<Tuple>, IEnumerable

Public MustInherit Class Browser
	Implements IEnumerator(Of Tuple), IDisposable, 
	IEnumerator, IEnumerable(Of Tuple), IEnumerable

public ref class Browser abstract : IEnumerator<Tuple^>, 
	IDisposable, IEnumerator, IEnumerable<Tuple^>, IEnumerable

[<AbstractClassAttribute>]
type Browser =  
    class
        interface IEnumerator<Tuple>
        interface IDisposable
        interface IEnumerator
        interface IEnumerable<Tuple>
        interface IEnumerable
    end

The Browser type exposes the following members.

Constructors

	Name	Description
	Browser	Initializes a new instance of the Browser class

Top

Methods

	Name	Description
	Create(Metaspace, String, BrowserDefBrowserType)	Creates the browser
	Create(Metaspace, String, BrowserDefBrowserType, BrowserDef)	Creates the browser
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveNext	Advances the enumerator to the next element of the collection.
	Reset	Sets the enumerator to its initial position, which is before the first element in the collection.
	Stop	Stops the browser.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	Current	Gets the element in the collection at the current position of the enumerator.
	IsPartial	Indicates if there could be more matching data for the specified filter
	Next	Return the next Tuple being browsed, or null if the Browser timed out waiting for a new Tuple to be put into the Space.
	Query	Sets the query.
	QueryLogs	Obsolete. Return the query logs.
	Size	Gets the actual size of the browser if SNAPSHOT and prefetch_all is used. Otherwise estimated size of the tuple to be returned from the browser
	Type	Return the type of Browser.

Top

Remarks

There are different types of Browsers, but all the Browsers implement a next() and a stop() method.
What the next() method does depends on the type of the Browser:

A Get Browser's next() method gets the next entry and returns it.
A Take Browser's next() method takes the next entry and returns it.
A Lock Browser's next() method locks the next entry and returns it.

(Take and Lock Browsers are always consistent with the space, this means that for example two separate Take Browsers on the same space (regardless of their location) will NEVER be able to take the same entry). Browsers are continuously updated (coherent) according to changes in the space being browsed (unless the browser's timescope is SNAPSHOT).
Unlike traditional iterators, browsers do not have a hasNext() method, but rather have a timeout which is the amount of time that the next() method call can block for while waiting for a new entry to 'next' on.
Space browsers also have a time scope and distribution scope.
Time scope limits the set of entries being browsed:

Time scope ALL means that all of the entries stored in the Space.
Time scope NEW means that only the entries stored after the browser creation will be browsed on
Time scope SNAPSHOT means that only the entries stored in the space at creation time will be browsed on (regardless of what happens to those entries after the browser creation time).

Distribution scope limits the set of entries or events being browsed on.

Distribution scope ALL means that all the entries in the Space will be browsed on.
Distribution scope SEEDED means that only the entries seeded by the member will be browsed on.

An optional filter can be applied to Browsers to refine the set of entries being browsed on.
Browsers do not guarantee any order of presentation of the entries.

Reference

Com.Tibco.As.Space.Browser Namespace

Com.Tibco.As.Space.BrowserBrowserDef