- com
- pcbsys
- nirvana
- client
- nQueuePeekContext
Provides a context when peeking on the queue. More...
Public Member Functions | |
| final int | getIndex () |
| Returns the index into the queue that the context is up to. More... | |
| final String | getSelector () |
| Retrieves the message selector (if any) set to filter events on this peek context. More... | |
| final int | getWindowSize () |
| Retrieves the size of the window used by this queue peek context. More... | |
| final boolean | hasMore () |
| Returns a boolean indicating if there are any more events in the queue. More... | |
| nQueuePeekContext () | |
| Default constructor that creates a queue peek context. | |
| nQueuePeekContext (final int windowSize) | |
| Creates a queue peek context with the specified window size. More... | |
| nQueuePeekContext (final int windowSize, final String selector) | |
| Creates a queue peek context with the specified window size and message selector to filter events with. More... | |
| final void | setHasMore (final boolean flag) |
| Sets the flag to true if more events in the queue. More... | |
| final void | setIndex (final int idx) |
| final void | setWindowSize (final int size) |
| Sets the size of the window. More... | |
Provides a context when peeking on the queue.
Useful when multple calls are required to traverse the entire queue.
| com.pcbsys.nirvana.client.nQueuePeekContext.nQueuePeekContext | ( | final 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 | ( | final int | windowSize, |
| final 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 |
| final int com.pcbsys.nirvana.client.nQueuePeekContext.getIndex | ( | ) |
Returns the index into the queue that the context is up to.
| final String com.pcbsys.nirvana.client.nQueuePeekContext.getSelector | ( | ) |
Retrieves the message selector (if any) set to filter events on this peek context.
| final int com.pcbsys.nirvana.client.nQueuePeekContext.getWindowSize | ( | ) |
Retrieves the size of the window used by this queue peek context.
| final boolean com.pcbsys.nirvana.client.nQueuePeekContext.hasMore | ( | ) |
Returns a boolean indicating if there are any more events in the queue.
| final void com.pcbsys.nirvana.client.nQueuePeekContext.setHasMore | ( | final boolean | flag | ) |
Sets the flag to true if more events in the queue.
(Server specific).
| flag | to specify whether there are more events to come |
| final void com.pcbsys.nirvana.client.nQueuePeekContext.setIndex | ( | final int | idx | ) |
| idx | Index value to set |
| final void com.pcbsys.nirvana.client.nQueuePeekContext.setWindowSize | ( | final int | size | ) |
Sets the size of the window.
| size | A size greater than 0 |