This class is the base class for all Queue Readers and provides a generic reader interface. More...
Public Member Functions | |
| abstract void | close () |
| This method is for internal use only More... | |
| abstract void | closeLocally () |
| This method is for internal use only More... | |
| bool | hasConsumedEvents () |
| Method to see whether the reader has consumed any events. More... | |
| bool | isClosed () |
| When a reader is closed, the physical subscription is closed at the server. More... | |
| bool | isClosedLocally () |
| A reader can be closed, but the physical subscription queue is not closed at the server. More... | |
| nConsumeEvent[] | peek (nQueuePeekContext context) |
| Performs a non destructive read More... | |
Static Public Member Functions | |
| static nQueuePeekContext | createContext () |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
| static nQueuePeekContext | createContext (int windowSize) |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
| static nQueuePeekContext | createContext (int windowSize, string selector) |
| Creates a Queue Peek Context, which is used to traverse the queue. More... | |
This class is the base class for all Queue Readers and provides a generic reader interface.
|
pure virtual |
This method is for internal use only
Abstract interface to be overridden by sub classes. Close the reader and the server subscription
Implemented in com.pcbsys.nirvana.client.nQueueSyncFragmentReader, com.pcbsys.nirvana.client.nQueueSyncReader, and com.pcbsys.nirvana.client.nQueueAsyncReader.
|
pure virtual |
This method is for internal use only
Abstract interface to be overridden by sub classes. Close the subscription, but do not notify the server
Implemented in com.pcbsys.nirvana.client.nQueueSyncFragmentReader, com.pcbsys.nirvana.client.nQueueSyncReader, and com.pcbsys.nirvana.client.nQueueAsyncReader.
|
static |
Creates a Queue Peek Context, which is used to traverse the queue.
|
static |
Creates a Queue Peek Context, which is used to traverse the queue.
| windowSize | The size of the window over the queue to uses |
|
static |
Creates a Queue Peek Context, which is used to traverse the queue.
| windowSize | The size of the window over the queue to uses |
| selector | A message selector to be applied on the events received |
| bool com.pcbsys.nirvana.client.nQueueReader.hasConsumedEvents | ( | ) |
Method to see whether the reader has consumed any events.
For transactional readers, this is reset every time commit or rollback is called.
| bool com.pcbsys.nirvana.client.nQueueReader.isClosed | ( | ) |
When a reader is closed, the physical subscription is closed at the server.
For Transactional readers, a close will rollback to the last committed event.
| bool com.pcbsys.nirvana.client.nQueueReader.isClosedLocally | ( | ) |
A reader can be closed, but the physical subscription queue is not closed at the server.
For Transactional readers, a local close will not rollback to the last committed event.
| nConsumeEvent [] com.pcbsys.nirvana.client.nQueueReader.peek | ( | nQueuePeekContext | context | ) |
Performs a non destructive read
| context | Peek Context to use. Used when multiple calls required to travers a queue |
| nSecurityException | If the client is not authorized to perform this request |
| nChannelNotFoundException | The queue was not found |
| nSessionNotConnectedException | Client is not currently connected to the server |
| nRequestTimedOutException | The server did not respond within the timeout |
| nUnexpectedResponseException | The server responded with an unexcepted response |
| nIllegalArgumentException | Invalid paramters passed |
| nSessionPausedException | The session is currently paused, please resume |
| nIllegalStateException | The operation could not complete because of a session/connection error |