com.pcbsys.nirvana.client.nPriorityDurable Class Reference

This class represent a Priority Durable implementation of nDurable Two subscribers can hold a subscription to the same named object. More...

Inherits com.pcbsys.nirvana.client.nBaseTopicDurable.

Public Member Functions

nDurableViewer createViewer () throws nUnexpectedResponseException, nSessionPausedException, nUnknownRemoteRealmException, nIllegalArgumentException, nSessionNotConnectedException, nIllegalChannelMode, nRequestTimedOutException, nChannelNotFoundException, nSecurityException
 Creates a nDurableViewer object for viewing the elements on a given durable object. More...
 
boolean 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...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nDurable
abstract void remove (long eid) throws nBaseClientException
 If supported this method will attempt to remove the event with the corresponding event ID from the durable object. More...
 
abstract void remove (long start, long end) throws nBaseClientException
 If supported this method will attempt to remove events between the start and end events on a durable. More...
 
abstract void remove (String filter) throws nBaseClientException
 If supported this method will attempt to remove events matching a filter on a durable. More...
 
abstract void removeAll () throws nBaseClientException
 If supported this method will attempt to remove all events on a durable. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nNamedObject
void ack (long[] eids) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException
 Acknowledge multiple events in one server call. More...
 
void ack (long[] eids, boolean isSynchronous) throws nIllegalArgumentException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException
 Acknowledge multiple events in one server call. More...
 
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...
 
String getName ()
 Returns the name of this client context. More...
 
long getOutstandingEvents ()
 If this object is shared, this method returns the number of messages outstanding to be consumed for this named object. More...
 
long getSharedNamedObjectOutstandingEvents ()
 If this object is shared, this method returns the number of messages outstanding to be consumed for this named object. More...
 
boolean isClusterWide ()
 Does this named object exist across the cluster. More...
 
boolean isDurableObjectInvalid ()
 When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object. More...
 
boolean isPersistent ()
 Will this named object be restored after the Realm Server has been restarted. More...
 
boolean 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...
 
boolean isQueued ()
 If set the named object will be having hidden queue based implementation. More...
 
boolean isSerial ()
 If set the named object will queue multiple subscribers and send events to them in a serial fashion (events are processed in the order that they are published across all consumers). More...
 
boolean isShared ()
 If set the named object will queue multiple subscribers and send events to them in a round-robin fashion. More...
 

Detailed Description

This class represent a Priority Durable implementation of nDurable Two subscribers can hold a subscription to the same named object.

One is given priority and will process events during normal operation. If, however, the subscriber with priority is disconnected for whatever reason, and is unable to process events, the second subscriber to that named object will take over and continue to process events as they come in. This allows failover, with backup subscribers handling events if the subscriber with priority goes down.

Since
9.12

Member Function Documentation

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 object which can be used to view the events on a given durable object in an iterative fashion
Exceptions
nBaseClientExceptionthis exception may be thrown by implementors if creating the viewer fails
Since
10.0

Implements com.pcbsys.nirvana.client.nDurable.

boolean com.pcbsys.nirvana.client.nPriorityDurable.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.

Returns
if the named object is cluster wide