com.pcbsys.nirvana.client.nBaseTopicDurable Class Reference

Abstract base class for the durable implementation on a topic. More...

Inheritance diagram for com.pcbsys.nirvana.client.nBaseTopicDurable:
com.pcbsys.nirvana.client.nDurable com.pcbsys.nirvana.client.nNamedObject com.pcbsys.nirvana.client.nExclusiveDurable com.pcbsys.nirvana.client.nPriorityDurable

Public Member Functions

override void acknowledge (nConsumeEventToken eventToken, bool isSynchronous)
 Sends an acknowledge request to the server for the given event id. More...
 
override nDurableViewer createViewer ()
 Creates a nDurableViewer object for viewing the elements on a given durable object. More...
 
override void remove (long eid)
 If supported, the method will attempt to remove the event with the given event ID from the durable object. More...
 
override void remove (long start, long end)
 If supported, the method will attempt to remove the events within the specified range from the durable object. More...
 
override void remove (string filter)
 If supported, the method will attempt to remove all events from the durable object which are matching the given filter. More...
 
override void removeAll ()
 If supported, the method will attempt to remove all events from the durable object. More...
 
override void rollback (nConsumeEventToken eventToken, bool isSynchronous)
 Rollbacks the given eventToken. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nNamedObject
long getEID ()
 Returns the current event ID that this named context is bound to More...
 
long getId ()
 Returns the unique ID of this client context. More...
 
long getLength ()
 Returns the total number of events for this particular named context. More...
 
string getName ()
 Returns the name of this client context More...
 
string getSelector ()
 Selector used for this durable object to filter events. More...
 
bool isClusterWide ()
 Does this named object exist across the cluster More...
 
bool isPersistent ()
 Will this named object be restored after the Realm Server has been restarted More...
 
virtual bool isPriorityEnabled ()
 If set the named object will queue multiple subscription such that the first subscriber will receive all events until it either disconnects or deletes the subscription, at which time, the next subscription request will start to receive events. More...
 
virtual bool isQueued ()
 Indicates whether the shared durable object is backed with a hidden queue. More...
 
virtual bool isSerial ()
 Indicates whether the durable object is shared. More...
 
virtual bool isShared ()
 Indicates whether the durable object is shared. More...
 

Detailed Description

Abstract base class for the durable implementation on a topic.

Member Function Documentation

override void com.pcbsys.nirvana.client.nBaseTopicDurable.acknowledge ( nConsumeEventToken  eventToken,
bool  isSynchronous 
)
virtual

Sends an acknowledge request to the server for the given event id.

The method will acknowledge the current event id and all unacknowledged events with ids less than the requested.

Parameters
eventTokenIdentifier of the event to be acknowledged.
isSynchronousif true, the thread will be held until the server has responded to the request

Implements com.pcbsys.nirvana.client.nDurable.

override nDurableViewer com.pcbsys.nirvana.client.nBaseTopicDurable.createViewer ( )
virtual

Creates a nDurableViewer object for viewing the elements on a given durable object.

Consuming events through this object using the nDurableViewer::next() method will not consume or acknowledge the events for the given durable.

Returns
an nDurableViewer instance that can be used to view the events on a durable object in an iterative manner

Implements com.pcbsys.nirvana.client.nDurable.

override void com.pcbsys.nirvana.client.nBaseTopicDurable.remove ( long  eid)
virtual

If supported, the method will attempt to remove the event with the given event ID from the durable object.

The support is limited and the operation is available only for shared and serial durables.

Exceptions
nIllegalStateExceptionThe exception is thrown if the operation is not supported.
Parameters
eidID of the event to purge

Implements com.pcbsys.nirvana.client.nDurable.

override void com.pcbsys.nirvana.client.nBaseTopicDurable.remove ( long  start,
long  end 
)
virtual

If supported, the method will attempt to remove the events within the specified range from the durable object.

The support is limited and the operation is available only for shared and serial durables.

Exceptions
nIllegalStateExceptionThe exception is thrown if the operation is not supported.
Parameters
startID of the event to start purging from
endID of the event to perge to

Implements com.pcbsys.nirvana.client.nDurable.

override void com.pcbsys.nirvana.client.nBaseTopicDurable.remove ( string  filter)
virtual

If supported, the method will attempt to remove all events from the durable object which are matching the given filter.

The support is limited and the operation is available only for shared and serial durables.

Exceptions
nIllegalStateExceptionThe exception is thrown if the operation is not supported.
Parameters
filterThe filter to be applied during perging

Implements com.pcbsys.nirvana.client.nDurable.

override void com.pcbsys.nirvana.client.nBaseTopicDurable.removeAll ( )
virtual

If supported, the method will attempt to remove all events from the durable object.

The support is limited and the operation is available only for shared and serial durables.

Exceptions
nIllegalStateExceptionThe exception is thrown if the operation is not supported.

Implements com.pcbsys.nirvana.client.nDurable.

override void com.pcbsys.nirvana.client.nBaseTopicDurable.rollback ( nConsumeEventToken  eventToken,
bool  isSynchronous 
)
virtual

Rollbacks the given eventToken.

The method will rollback the current event id and all unacknowledged events with ids less than the requested.

Parameters
eventTokenIdentifier or the event to be rollbacked
isSynchronousif true, the thread will be held until the server has responded to the request
Exceptions
nIllegalStateExceptionThe exception is thrown if the operation is not supported.

Implements com.pcbsys.nirvana.client.nDurable.