com.pcbsys.nirvana.client.nNamedObject Class Reference

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

Inheritance diagram for com.pcbsys.nirvana.client.nNamedObject:
com.pcbsys.nirvana.client.nDurable com.pcbsys.nirvana.client.nIndexedDurable com.pcbsys.nirvana.client.nSerialDurable com.pcbsys.nirvana.client.nSharedDurable

Public Member Functions

nDurableDetails getDetails ()
 This method returns an object with the durable details.
 
long getEID ()
 Returns the current event ID that this named context is bound to.
 
long getId ()
 Returns the unique ID of this client context.
 
long getLength ()
 Returns the total number of events for this particular named context.
 
string getName ()
 Returns the name of this client context.
 
string getSelector ()
 Selector used for this durable object to filter events.
 
virtual 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.
 
virtual bool isQueued ()
 Indicates whether the shared durable object is backed with a hidden queue.
 
virtual bool isSerial ()
 Indicates whether the durable object is shared.
 
virtual bool isShared ()
 Indicates whether the durable object is shared.
 

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

◆ getDetails()

nDurableDetails com.pcbsys.nirvana.client.nNamedObject.getDetails ( )

This method returns an object with the durable details.

Returns
nDurableDetails

◆ getEID()

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

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

Returns
long event ID

◆ getId()

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

Returns the unique ID of this client context.

Returns
Unique ID for the durable

◆ getLength()

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

Returns the total number of events for this particular named context.

If the named object is not shared then this method will always return -1

Returns
long length

◆ getName()

string com.pcbsys.nirvana.client.nNamedObject.getName ( )

Returns the name of this client context.

Returns
String

◆ getSelector()

string com.pcbsys.nirvana.client.nNamedObject.getSelector ( )

Selector used for this durable object to filter events.

Returns
selector used as an event filter

◆ isPriorityEnabled()

virtual bool com.pcbsys.nirvana.client.nNamedObject.isPriorityEnabled ( )
virtual

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

◆ isQueued()

virtual bool com.pcbsys.nirvana.client.nNamedObject.isQueued ( )
virtual

Indicates whether the shared durable object is backed with a hidden queue.

Queued durables are no longer supported. The flag is used for backwards compatibility and only query based operations are supported for this type.

Returns
whether the shared durable is backed with a hidden queue

◆ isSerial()

virtual bool com.pcbsys.nirvana.client.nNamedObject.isSerial ( )
virtual

Indicates whether the durable object is shared.

If true, multiple subscribers are queued and events are sent in a serial fashion.

Returns
whether the durable is serial

◆ isShared()

virtual bool com.pcbsys.nirvana.client.nNamedObject.isShared ( )
virtual

Indicates whether the durable object is shared.

If true, multiple subscribers are queued and events are sent in a round-robin fashion.

Returns
whether the durable is shared