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

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

Syntax

C#
public abstract class Browser : IEnumerator<Tuple>, 
	IDisposable, IEnumerator, IEnumerable<Tuple>, IEnumerable
Visual Basic
Public MustInherit Class Browser
	Implements IEnumerator(Of Tuple), IDisposable, 
	IEnumerator, IEnumerable(Of Tuple), IEnumerable
Visual C++
public ref class Browser abstract : IEnumerator<Tuple^>, 
	IDisposable, IEnumerator, IEnumerable<Tuple^>, IEnumerable
F#
[<AbstractClassAttribute>]
type Browser =  
    class
        interface IEnumerator<Tuple>
        interface IDisposable
        interface IEnumerator
        interface IEnumerable<Tuple>
        interface IEnumerable
    end

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.

Inheritance Hierarchy

System..::..Object
  Com.Tibco.As.Space.Browser..::..Browser

See Also