com::pcbsys::nirvana::client::nQueueAsyncTransactionReader Class Reference

This Reader enables the client to receive all events asynchronously. More...

#include <nQueueAsyncTransactionReader.h>

Inheritance diagram for com::pcbsys::nirvana::client::nQueueAsyncTransactionReader:
com::pcbsys::nirvana::client::nQueueAsyncReader com::pcbsys::nirvana::client::nQueueTransactionReader com::pcbsys::nirvana::client::nQueueReader

Public Member Functions

virtual void commit ()
 Commits all received events so far. More...
 
virtual void commit (longlong eventId)
 Commits all events up to the event id specified. More...
 
virtual void rollback ()
 Rolls back all received events that have not been committed or rolled back previously. More...
 
virtual void rollback (longlong eventId)
 Rolls back all events up to the specified event id that have not been committed or rolled back previously. More...
 
- Public Member Functions inherited from com::pcbsys::nirvana::client::nQueueAsyncReader
virtual void close ()
 Close the subscription, and notify the server.
 
virtual void closeLocally ()
 Close the subscription, but don't notify the server.
 
- Public Member Functions inherited from com::pcbsys::nirvana::client::nQueueReader
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 *pContext, int &nEvent)
 Performs a non destructive read. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from com::pcbsys::nirvana::client::nQueueReader
static nQueuePeekContextcreateContext (int windowSize=0, const std::string &selector="")
 Creates a Queue Peek Context, which is used to traverse the queue. More...
 

Detailed Description

This Reader enables the client to receive all events asynchronously.

The callback method was passed as part of the nQueueReaderContext. This class provides no pop methods, since it is all asynchronous delivery.

Member Function Documentation

virtual void com::pcbsys::nirvana::client::nQueueAsyncTransactionReader::commit ( )
virtual
virtual void com::pcbsys::nirvana::client::nQueueAsyncTransactionReader::commit ( longlong  eventId)
virtual

Commits all events up to the event id specified.

This means you can partially commit received events.

Parameters
eventIdEvent ID to commit to, inclusive
Exceptions
nSessionNotConnectedException
nRequestTimedOutException
nIllegalStateException

Implements com::pcbsys::nirvana::client::nQueueTransactionReader.

virtual void com::pcbsys::nirvana::client::nQueueAsyncTransactionReader::rollback ( )
virtual

Rolls back all received events that have not been committed or rolled back previously.

These events are then pushed back onto the queue for redelivery.

Exceptions
nSessionNotConnectedException
nRequestTimedOutException
nIllegalStateException

Implements com::pcbsys::nirvana::client::nQueueTransactionReader.

virtual void com::pcbsys::nirvana::client::nQueueAsyncTransactionReader::rollback ( longlong  eventId)
virtual

Rolls back all events up to the specified event id that have not been committed or rolled back previously.

These events are then pushed back onto the queue for redelivery.

Parameters
eventIdEvent Id to rollback to, inclusive
Exceptions
nSessionNotConnectedException
nRequestTimedOutException
nIllegalStateException

Implements com::pcbsys::nirvana::client::nQueueTransactionReader.