Provides a context when peeking on the queue. More...
Public Member Functions | |||
| int | getIndex () | ||
| Returns the index into the queue that the context is up to. More... | |||
| string | getSelector () | ||
| Retrieves the message selector (if any) set to filter events on this peek context. More... | |||
| int | getWindowSize () | ||
| Retrieves the size of the window used by this queue peek context. More... | |||
| bool | hasMore () | ||
| Returns a boolean indicating if there are any more events in the queue. More... | |||
| nQueuePeekContext () | |||
| Default constructor that creates a queue peek context. More... | |||
| nQueuePeekContext (int windowSize) | |||
| Creates a queue peek context with the specified window size. More... | |||
| nQueuePeekContext (int windowSize, string selector) | |||
| Creates a queue peek context with the specified window size and message selector to filter events with. More... | |||
| void | setHasMore (bool flag) | ||
| Sets the flag to true if more events in the queue. More... | |||
| void | setIndex (int idx) | ||
| |||
| void | setWindowSize (int size) | ||
| Sets the size of the window. More... | |||
Provides a context when peeking on the queue.
Useful when multiple calls are required to traverse the entire queue.
| com.pcbsys.nirvana.client.nQueuePeekContext.nQueuePeekContext | ( | ) |
Default constructor that creates a queue peek context.
| com.pcbsys.nirvana.client.nQueuePeekContext.nQueuePeekContext | ( | int | windowSize | ) |
Creates a queue peek context with the specified window size.
| windowSize | Number of events which will be delivered to the client per lookup |
| com.pcbsys.nirvana.client.nQueuePeekContext.nQueuePeekContext | ( | int | windowSize, |
| string | selector | ||
| ) |
Creates a queue peek context with the specified window size and message selector to filter events with.
| windowSize | Number of events which will be delivered to the client per lookup |
| selector | Message selector to apply to the events |
| int com.pcbsys.nirvana.client.nQueuePeekContext.getIndex | ( | ) |
Returns the index into the queue that the context is up to.
| string com.pcbsys.nirvana.client.nQueuePeekContext.getSelector | ( | ) |
Retrieves the message selector (if any) set to filter events on this peek context.
| int com.pcbsys.nirvana.client.nQueuePeekContext.getWindowSize | ( | ) |
Retrieves the size of the window used by this queue peek context.
| bool com.pcbsys.nirvana.client.nQueuePeekContext.hasMore | ( | ) |
Returns a boolean indicating if there are any more events in the queue.
| void com.pcbsys.nirvana.client.nQueuePeekContext.setHasMore | ( | bool | flag | ) |
Sets the flag to true if more events in the queue.
(Server specific).
| flag | to specify whether there are more events to come |
| void com.pcbsys.nirvana.client.nQueuePeekContext.setWindowSize | ( | int | size | ) |
Sets the size of the window.
| size | A size greater than 0 |