- com
- pcbsys
- nirvana
- client
- nQueueAsyncTransactionReader
This class extends the asynchronous queue model by adding the transactional ability to the reader. More...
Public Member Functions | |
| final void | commit () throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nIllegalStateException |
| Commits all received events so far. More... | |
| final void | commit (final long eventId) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Commits all events up to the event id specified. More... | |
| final void | commit (final long eventId, boolean ackPrevious) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Commits all events up to the event id specified. More... | |
| final void | rollback () throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nIllegalStateException |
| Rollbacks all received events that have not been committed or rollbacked previously. More... | |
| final void | rollback (final long eventId) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Rollbacks all events up to the specified event id that have not been committed or rollbacked previously. More... | |
| final void | rollback (final long eventId, boolean individualRollback) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Rollbacks all events up to the specified event id that have not been committed or rollbacked previously. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.client.nQueueAsyncReader | |
| String | getReaderId () throws nSessionNotConnectedException |
| Returns the server side unique id of the reader. More... | |
| boolean | isPaused () |
| Returns true if the subscription of the reader is currently paused. More... | |
| void | pauseReader () throws nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nChannelNotFoundException |
| Pause the subscription of the nQueueAsyncReader. More... | |
| void | resumeReader () throws nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nChannelNotFoundException |
| Resumes the subscription of the nQueueAsyncReader. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.client.nQueueReader | |
| void | destroyReader () throws nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException |
| This call will release any outstanding resources on the server and close the reader. More... | |
| void | destroyReaderLocally () |
| This call will close local reader resources but remain subscribed at the server Any future calls to this object will work unless destroyReader() is called. More... | |
| int | getUniqueReaderId () |
| Returns the id of the nQueueReader instance which is automatically set on reader creation and sent to the server with each nPopQueue operation. More... | |
| boolean | hasConsumedEvents () |
| Method to see whether the reader has consumed any events. More... | |
| boolean | isClosed () |
| When a reader is closed, the physical subscription is closed at the server. More... | |
| boolean | isClosedLocally () |
| A reader can be closed, but the physical subscription queue is not closed at the server. More... | |
| final nConsumeEvent[] | peek (final nQueuePeekContext context) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSessionPausedException, nIllegalArgumentException, nIllegalStateException |
| Performs a non destructive read. More... | |
| Public Member Functions inherited from com.pcbsys.nirvana.client.nQueueTransactionReader | |
| void | commit (long eventId) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Commits all events up to the event id specified. More... | |
| void | commit (long eventId, boolean ackPrevious) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Commits all events up to the event id specified. More... | |
| void | rollback (long eventId) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| Rollbacks all events up to the specified event id that have not been committed or rollbacked previously. More... | |
| void | rollback (long eventId, boolean isIndividual) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
| If isIndividual then this rolls back just the event with the specified event ID. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from com.pcbsys.nirvana.client.nQueueReader | |
| static nQueuePeekContext | createContext () |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
| static nQueuePeekContext | createContext (final int windowSize) |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
| static nQueuePeekContext | createContext (final int windowSize, final String selector) |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
| Protected Attributes inherited from com.pcbsys.nirvana.client.nQueueReader | |
| final int | myUniqueReaderId |
| The unique id of this nQueueReader instance. More... | |
This class extends the asynchronous queue model by adding the transactional ability to the reader.
This enables the client to commit already received events or roll them back. When a rollback occurs the events that have not been committed by this client are then pushed back onto the queue for redelivery to other clients.
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.commit | ( | ) | throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nIllegalStateException |
Commits all received events so far.
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |
Implements com.pcbsys.nirvana.client.nQueueTransactionReader.
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.commit | ( | final long | eventId | ) | throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
Commits all events up to the event id specified.
This means you can partially commit received events.
| eventId | Event ID to commit to, inclusive |
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.commit | ( | final long | eventId, |
| boolean | ackPrevious | ||
| ) | throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
Commits all events up to the event id specified.
This means you can partially commit received events.
| eventId | Event ID to commit to, inclusive |
| ackPrevious | if true then all events consumed prior to this eventId will also be committed (defaults to true) |
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.rollback | ( | ) | throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nIllegalStateException |
Rollbacks all received events that have not been committed or rollbacked previously.
These events are then pushed back onto the queue for redelivery.
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |
Implements com.pcbsys.nirvana.client.nQueueTransactionReader.
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.rollback | ( | final long | eventId | ) | throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
Rollbacks all events up to the specified event id that have not been committed or rollbacked previously.
These events are then pushed back onto the queue for redelivery.
| eventId | Event Id to rollback to, inclusive |
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |
| final void com.pcbsys.nirvana.client.nQueueAsyncTransactionReader.rollback | ( | final long | eventId, |
| boolean | individualRollback | ||
| ) | throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nIllegalStateException |
Rollbacks all events up to the specified event id that have not been committed or rollbacked previously.
These events are then pushed back onto the queue for redelivery.
| eventId | Event Id to rollback to, inclusive |
| individualRollback | if true, discard only this event and request redelivery. If false, keep this event but redeliver anything received after this event. |
| nSessionNotConnectedException | if the session for this store is not currently connected |
| nRequestTimedOutException | if there is no response to the request to set the store's descriptors within the timeout period. |
| nSessionPausedException | if the session for this store is currently paused |
| nIllegalStateException | This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is 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. |