com.pcbsys.nirvana.client.nNamedObject Class Reference

This class represents a client context on a RealmServer. More...

Public Member Functions

long getEID ()
 Returns the current event ID that this named context is bound to. More...
 
String getName ()
 Returns the name of this client context. More...
 
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 isShared ()
 Will this named object be restored after the Realm Server has been restarted. More...
 

Detailed Description

This class represents a client context on a RealmServer.

In as much as that if a client session is closed and sometime later a new client session is created by referencing this named object the client can resume where they were

Member Function Documentation

long com.pcbsys.nirvana.client.nNamedObject.getEID ( )

Returns the current event ID that this named context is bound to.

Returns
long event ID
String com.pcbsys.nirvana.client.nNamedObject.getName ( )

Returns the name of this client context.

Returns
String
boolean com.pcbsys.nirvana.client.nNamedObject.isClusterWide ( )

Does this named object exist across the cluster.

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

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

Returns
boolean flag
boolean com.pcbsys.nirvana.client.nNamedObject.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.client.nNamedObject.isShared ( )

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

Returns
boolean flag