- com
- pcbsys
- nirvana
- client
- nNamedObject
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 | getOutstandingEvents () |
| If this object is shared, this method returns the number of messages outstanding to be consumed for this named object. 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 | isDurableObjectInvalid () |
| When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object. 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 | isQueued () |
| If set the named object will be having hidden queue based implementation. More... | |
| boolean | isSerial () |
| If set the named object will queue multiple subscribers and send events to them in a serial fashion (events are processed in the order that they are published across all consumers). More... | |
| boolean | isShared () |
| If set the named object will queue multiple subscribers and send events to them in a round-robin fashion. More... | |
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
| 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.
| eids | an array of the event IDs to be acknowledged. |
| nIllegalArgumentException | thrown if the event IDs were not consumed by this connection or if the named object is not shared. Also if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server. Some other conditions are if the event IDs were not consumed by this connection or if the named object is not shared. |
| nSessionNotConnectedException | we cannot write to the server if the session is not open |
| nSessionPausedException | we cannot write to the server if the session is not open |
| nRequestTimedOutException | the 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.
| eids | an array of the event IDs to be acknowledged. |
| isSynchronous | if true, the thread will be held until the server has responded to the request |
| nIllegalArgumentException | thrown if the event IDs were not consumed by this connection or if the named object is not shared. Also if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server. Some other conditions are if the event IDs were not consumed by this connection or if the named object is not shared. |
| nSessionNotConnectedException | we cannot write to the server if the session is not open |
| nSessionPausedException | we cannot write to the server if the session is not open |
| nRequestTimedOutException | the 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.
| long com.pcbsys.nirvana.client.nNamedObject.getID | ( | ) |
Returns the unique ID of this client context.
| String com.pcbsys.nirvana.client.nNamedObject.getName | ( | ) |
Returns the name of this client context.
| long com.pcbsys.nirvana.client.nNamedObject.getOutstandingEvents | ( | ) |
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
| 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
| boolean com.pcbsys.nirvana.client.nNamedObject.isClusterWide | ( | ) |
Does this named object exist across the cluster.
| boolean com.pcbsys.nirvana.client.nNamedObject.isDurableObjectInvalid | ( | ) |
When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object.
| boolean com.pcbsys.nirvana.client.nNamedObject.isPersistent | ( | ) |
Will this named object be restored after the Realm Server has been restarted.
| 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.
| boolean com.pcbsys.nirvana.client.nNamedObject.isQueued | ( | ) |
If set the named object will be having hidden queue based implementation.
| boolean com.pcbsys.nirvana.client.nNamedObject.isSerial | ( | ) |
If set the named object will queue multiple subscribers and send events to them in a serial fashion (events are processed in the order that they are published across all consumers).
| boolean com.pcbsys.nirvana.client.nNamedObject.isShared | ( | ) |
If set the named object will queue multiple subscribers and send events to them in a round-robin fashion.