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

nDurableConnectionNode findConnection (String id)
 
Iterator< nDurableConnectionNode > getConnections ()
 The value will not be updated immediately when nDurableNode is created. More...
 
long getDepth ()
 The value will not be updated immediately when nDurableNode is created. More...
 
long getLastEventId ()
 The value will not be updated immediately when nDurableNode is created. More...
 
long getLastReadTime ()
 The value will not be updated immediately when nDurableNode is created. More...
 
long getLastWriteTime ()
 The value will not be updated immediately when nDurableNode is created. More...
 
long getStoreSize ()
 Store size is not relevant to nDurableType#Shared, nDurableType#Serial, nDurableType#Named durables.only useful for Shared Queued durables. More...
 
long getTransactionDepth ()
 The value will not be updated immediately when nDurableNode is created. More...
 
Long getUniqueId ()
 
boolean isSerial ()
 Returns true if the durable type is nDurableType#Serial. More...
 
boolean isShared ()
 Returns true if the durable type is nDurableType#Shared. More...
 
boolean isStatusInitialised ()
 Returns true when this node receives the first server update. 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

nDurableConnectionNode com.pcbsys.nirvana.nAdminAPI.nDurableNode.findConnection ( String  id)
Parameters
idConnection ID in the format host:port
Returns
nDurableConnectionNode corresponding to the connection ID, null if the connection ID specified is not present
Iterator<nDurableConnectionNode> com.pcbsys.nirvana.nAdminAPI.nDurableNode.getConnections ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised()

Returns
An iterator of all connections for this durable
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getDepth ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised()

Returns
The number of outstanding events for this Durable.Equivalent to nDurable#getOutstandingEvents()
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getLastEventId ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised()

Returns
last acknowledged event ID
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getLastReadTime ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised() When durable is created, it will be initialized with the durable creation time

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 ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised(). When durable is created, it will be initialized with the durable creation time

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 ( )

Store size is not relevant to nDurableType#Shared, nDurableType#Serial, nDurableType#Named durables.only useful for Shared Queued durables.

Returns
The size of the underlying store
long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getTransactionDepth ( )

The value will not be updated immediately when nDurableNode is created.

Server updates the value asynchronously and might take some time to update. By Default server sends update every 5 seconds, this time interval can be controlled by server config "Global Values->StatusBroadcast" To check first update on this node from server use nDurableNode#isStatusInitialised() Applicable only for nDurableType#Shared, nDurableType#Serial types

Returns
The number of events waiting for Commit or a rollback
Long com.pcbsys.nirvana.nAdminAPI.nDurableNode.getUniqueId ( )
Returns
long Unique ID of the Durable
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isSerial ( )

Returns true if the durable type is nDurableType#Serial.

Returns
true if the type is nDurableType#Serial
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isShared ( )

Returns true if the durable type is nDurableType#Shared.

Returns
true if the durable type is nDurableType#Shared
boolean com.pcbsys.nirvana.nAdminAPI.nDurableNode.isStatusInitialised ( )

Returns true when this node receives the first server update.

This flag will never be reset, hence consecutive updates will also return true

Returns
true when first Async update is received from the server