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...
 
long getLength ()
 Returns the total number of events for this particular named context More...
 
string getName ()
 Returns the name of this client context 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...
 
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...
 

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
long com.pcbsys.nirvana.client.nNamedObject.getLength ( )

Returns the total number of events for this particular named context

Returns
long length
string com.pcbsys.nirvana.client.nNamedObject.getName ( )

Returns the name of this client context

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

Does this named object exist across the cluster

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

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

Returns
bool flag
bool 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