com.pcbsys.nirvana.nAdminAPI.nDurableNode Class Reference

Represents the current nDurable status. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nDurableNode:
com.pcbsys.nirvana.nAdminAPI.nNode

Public Member Functions

Iterator< nDurableConnectionNodegetConnections ()
 
long getDepth ()
 
long getLastEventId ()
 
long getLastReadTime ()
 
long getLastWriteTime ()
 
long getStoreSize ()
 
long getTransactionDepth ()
 
Long getUniqueId ()
 
boolean isClusterWide ()
 Does this named object exist across the cluster. 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 ()
 Is the Durable configured to use the hidden queue, this will be deprecated in up coming releases. More...
 
boolean isSerial ()
 If set the durable 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 ()
 Returns true if the durable is of type Shared. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode
boolean equals (long aLong)
 Needed as part of the SortedObject interface.
 
synchronized String getAbsolutePath ()
 This function walks the tree to the root to generate a fully qualified name for this node. More...
 
String getName ()
 Returns the generic name of this node within the namespace. More...
 
nNode getParent ()
 Returns this nodes parent node. More...
 
String getRelativePath (nNode top) throws nAdminIllegalArgumentException
 This method returns the relative path from this node to the nNode passed. More...
 
boolean isMatch (Object item)
 Compares this object with the passed object. More...
 
boolean lessThan (long aLong)
 Needed as part of the SortedObject interface.
 
boolean lessThan (Object item)
 Compares this object with the passed object. More...
 

Detailed Description

Represents the current nDurable status.

Member Function Documentation

Iterator<nDurableConnectionNode> com.pcbsys.nirvana.nAdminAPI.nDurableNode.getConnections ( )
Returns
An iterator of all connections for this durable
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getDepth ( )
Returns
The number of events outstanding for this particular Durable. For non-shared durables this method returns an estimation of the outstanding events. This estimation does not include unacknowledged, purged and filtered events.
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getLastEventId ( )
Returns
The Event ID that the Durable is up
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getLastReadTime ( )
Returns
The time that the durable was last read from, this could include reading an event, committing an event or rolling back an event
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getLastWriteTime ( )
Returns
The time that the durable was last written to, typically this is the last time an event was added to the durable
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getStoreSize ( )
Returns
The size of the underlying store, only useful for Shared Queued durables
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getTransactionDepth ( )
Returns
The number of outstanding events waiting for an Commit or a rollback
Long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getUniqueId ( )
Returns
Returns the Durables unique ID
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isClusterWide ( )

Does this named object exist across the cluster.

Returns
if the named object is cluster wide
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isPersistent ( )

Will this named object be restored after the Realm Server has been restarted.

Returns
boolean flag
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.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
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isQueued ( )

Is the Durable configured to use the hidden queue, this will be deprecated in up coming releases.

Returns
true if using the old mechanism
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isSerial ( )

If set the durable 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).

Returns
Returns true if the durable is of type Serial
Since
10.1
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isShared ( )

Returns true if the durable is of type Shared.

Returns
boolean flag