com.pcbsys.nirvana.client.nNamedObject Class Reference

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

Public Member Functions

void ack (long[] eids) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException
 Acknowledge multiple events in one server call. More...
 
void ack (long[] eids, boolean isSynchronous) throws nIllegalArgumentException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException
 Acknowledge multiple events in one server call. More...
 
long getEID ()
 Returns the current event ID that this named context is bound to. More...
 
long getID ()
 Returns the unique ID of this client context. More...
 
String getName ()
 Returns the name of this client context. More...
 
long getSharedNamedObjectOutstandingEvents ()
 If this object is shared, this method returns the number of messages outstanding to be consumed for this named object. 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

void com.pcbsys.nirvana.client.nNamedObject.ack ( long[]  eids) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException

Acknowledge multiple events in one server call.

The first argument contains all of the event IDs that you want to commit. This is functionally equivalent to calling nConsumeEvent.ack() for each event.

Parameters
eidsan array of the event IDs to be acknowledged.
Exceptions
nIllegalArgumentExceptionthrown if the event IDs were not consumed by this connection or if the named object is not shared
nSessionNotConnectedExceptionwe cannot write to the server if the session is not open
nSessionPausedExceptionwe cannot write to the server if the session is not open
nRequestTimedOutExceptionthe server did not respond within the time allocated
void com.pcbsys.nirvana.client.nNamedObject.ack ( long[]  eids,
boolean  isSynchronous 
) throws nIllegalArgumentException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException

Acknowledge multiple events in one server call.

The first argument contains all of the event IDs that you want to commit. This is functionally equivalent to calling nConsumeEvent.ack() for each event.

Parameters
eidsan array of the event IDs to be acknowledged.
isSynchronousif true, the thread will be held until the server has responded to the request
Exceptions
nIllegalArgumentExceptionthrown if the event IDs were not consumed by this connection or if the named object is not shared
nSessionNotConnectedExceptionwe cannot write to the server if the session is not open
nSessionPausedExceptionwe cannot write to the server if the session is not open
nRequestTimedOutExceptionthe server did not respond within the time allocated
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.getID ( )

Returns the unique ID of this client context.

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

Returns the name of this client context.

Returns
String
long com.pcbsys.nirvana.client.nNamedObject.getSharedNamedObjectOutstandingEvents ( )

If this object is shared, this method returns the number of messages outstanding to be consumed for this named object.

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

Returns
long length
Since
9.9
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