Abstract representation of a durable subscription. More...
Public Member Functions | |
| abstract void | acknowledge (nConsumeEventToken eventToken, bool isSynchronous) |
| Sends an acknowledge request to the server for the given event id. More... | |
| abstract nDurableViewer | createViewer () |
| Creates a nDurableViewer object for viewing the elements on a given durable object. More... | |
| abstract void | remove (long eid) |
| If supported, the method will attempt to remove the event with the given event ID from the durable object. More... | |
| abstract void | remove (long start, long end) |
| If supported, the method will attempt to remove the events within the specified range from the durable object. More... | |
| abstract void | remove (string filter) |
| If supported, the method will attempt to remove all events from the durable object which are matching the given filter. More... | |
| abstract void | removeAll () |
| If supported, the method will attempt to remove all events from the durable object. More... | |
| abstract void | rollback (nConsumeEventToken eventToken, bool isSynchronous) |
| Rollbacks the given eventToken. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.client.nNamedObject | |
| 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... | |
| long | getLength () |
| Returns the total number of events for this particular named context. More... | |
| string | getName () |
| Returns the name of this client context More... | |
| string | getSelector () |
| Selector used for this durable object to filter events. 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... | |
| 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. More... | |
| virtual bool | isQueued () |
| Indicates whether the shared durable object is backed with a hidden queue. More... | |
| virtual bool | isSerial () |
| Indicates whether the durable object is shared. More... | |
| virtual bool | isShared () |
| Indicates whether the durable object is shared. More... | |
Abstract representation of a durable subscription.
Provides a minimum set of methods to create views for a given durable object and to remove events from a durable, if supported by the concrete implementation. Implementations of this class represent supported types of durable subscriptions.
|
pure virtual |
Sends an acknowledge request to the server for the given event id.
The method will acknowledge the current event id and all unacknowledged events with ids less than the requested.
| eventToken | Identifier of the event to be acknowledged. |
| isSynchronous | if true, the thread will be held until the server has responded to the request |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
Creates a nDurableViewer object for viewing the elements on a given durable object.
Consuming events through this object using the nDurableViewer::next() method will not consume or acknowledge the events for the given durable.
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
If supported, the method will attempt to remove the event with the given event ID from the durable object.
The support is limited and the operation is available only for shared and serial durables.
| nIllegalStateException | The exception is thrown if the operation is not supported. |
| eid | ID of the event to purge |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
If supported, the method will attempt to remove the events within the specified range from the durable object.
The support is limited and the operation is available only for shared and serial durables.
| nIllegalStateException | The exception is thrown if the operation is not supported. |
| start | ID of the event to start purging from |
| end | ID of the event to perge to |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
If supported, the method will attempt to remove all events from the durable object which are matching the given filter.
The support is limited and the operation is available only for shared and serial durables.
| nIllegalStateException | The exception is thrown if the operation is not supported. |
| filter | The filter to be applied during perging |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
If supported, the method will attempt to remove all events from the durable object.
The support is limited and the operation is available only for shared and serial durables.
| nIllegalStateException | The exception is thrown if the operation is not supported. |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.
|
pure virtual |
Rollbacks the given eventToken.
The method will rollback the current event id and all unacknowledged events with ids less than the requested.
| eventToken | Identifier or the event to be rollbacked |
| isSynchronous | if true, the thread will be held until the server has responded to the request |
| nIllegalStateException | The exception is thrown if the operation is not supported. |
Implemented in com.pcbsys.nirvana.client.nIndexedDurable, and com.pcbsys.nirvana.client.nBaseTopicDurable.