Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Public Member Functions | Protected Attributes | List of all members
qpid::client::no_keyword::AsyncSession_0_10 Class Reference

AMQP 0-10 asynchronous session API. More...

#include <qpid/client/no_keyword/AsyncSession_0_10.h>

Public Member Functions

 AsyncSession_0_10 ()
 
QPID_CLIENT_INLINE_EXTERN AsyncSession_0_10 (const SessionBase_0_10 &other)
 
QPID_CLIENT_INLINE_EXTERN
AsyncSession_0_10
operator= (const SessionBase_0_10 &other)
 
Completion executionSync (bool sync=false)
 
Completion executionResult (const SequenceNumber &commandId=SequenceNumber(), const std::string &value=std::string(), bool sync=false)
 
Completion executionException (uint16_t errorCode=0, const SequenceNumber &commandId=SequenceNumber(), uint8_t classCode=0, uint8_t commandCode=0, uint8_t fieldIndex=0, const std::string &description=std::string(), const FieldTable &errorInfo=FieldTable(), bool sync=false)
 
Completion messageTransfer (const std::string &destination=std::string(), uint8_t acceptMode=1, uint8_t acquireMode=0, const Message &content=Message(std::string()), bool sync=false)
 
Completion messageAccept (const SequenceSet &transfers=SequenceSet(), bool sync=false)
 
Completion messageReject (const SequenceSet &transfers=SequenceSet(), uint16_t code=0, const std::string &text=std::string(), bool sync=false)
 
Completion messageRelease (const SequenceSet &transfers=SequenceSet(), bool setRedelivered=false, bool sync=false)
 
TypedResult
< qpid::framing::MessageAcquireResult
messageAcquire (const SequenceSet &transfers=SequenceSet(), bool sync=false)
 
TypedResult
< qpid::framing::MessageResumeResult
messageResume (const std::string &destination=std::string(), const std::string &resumeId=std::string(), bool sync=false)
 
Completion messageSubscribe (const std::string &queue=std::string(), const std::string &destination=std::string(), uint8_t acceptMode=0, uint8_t acquireMode=0, bool exclusive=false, const std::string &resumeId=std::string(), uint64_t resumeTtl=0, const FieldTable &arguments=FieldTable(), bool sync=false)
 
Completion messageCancel (const std::string &destination=std::string(), bool sync=false)
 
Completion messageSetFlowMode (const std::string &destination=std::string(), uint8_t flowMode=0, bool sync=false)
 
Completion messageFlow (const std::string &destination=std::string(), uint8_t unit=0, uint32_t value=0, bool sync=false)
 
Completion messageFlush (const std::string &destination=std::string(), bool sync=false)
 
Completion messageStop (const std::string &destination=std::string(), bool sync=false)
 
Completion txSelect (bool sync=false)
 
Completion txCommit (bool sync=false)
 
Completion txRollback (bool sync=false)
 
Completion dtxSelect (bool sync=false)
 
TypedResult
< qpid::framing::XaResult
dtxStart (const Xid &xid=Xid(), bool join=false, bool resume=false, bool sync=false)
 
TypedResult
< qpid::framing::XaResult
dtxEnd (const Xid &xid=Xid(), bool fail=false, bool suspend=false, bool sync=false)
 
TypedResult
< qpid::framing::XaResult
dtxCommit (const Xid &xid=Xid(), bool onePhase=false, bool sync=false)
 
Completion dtxForget (const Xid &xid=Xid(), bool sync=false)
 
TypedResult
< qpid::framing::DtxGetTimeoutResult
dtxGetTimeout (const Xid &xid=Xid(), bool sync=false)
 
TypedResult
< qpid::framing::XaResult
dtxPrepare (const Xid &xid=Xid(), bool sync=false)
 
TypedResult
< qpid::framing::DtxRecoverResult
dtxRecover (bool sync=false)
 
TypedResult
< qpid::framing::XaResult
dtxRollback (const Xid &xid=Xid(), bool sync=false)
 
Completion dtxSetTimeout (const Xid &xid=Xid(), uint32_t timeout=0, bool sync=false)
 
Completion exchangeDeclare (const std::string &exchange=std::string(), const std::string &type=std::string(), const std::string &alternateExchange=std::string(), bool passive=false, bool durable=false, bool autoDelete=false, const FieldTable &arguments=FieldTable(), bool sync=false)
 
Completion exchangeDelete (const std::string &exchange=std::string(), bool ifUnused=false, bool sync=false)
 
TypedResult
< qpid::framing::ExchangeQueryResult
exchangeQuery (const std::string &name=std::string(), bool sync=false)
 
Completion exchangeBind (const std::string &queue=std::string(), const std::string &exchange=std::string(), const std::string &bindingKey=std::string(), const FieldTable &arguments=FieldTable(), bool sync=false)
 
Completion exchangeUnbind (const std::string &queue=std::string(), const std::string &exchange=std::string(), const std::string &bindingKey=std::string(), bool sync=false)
 
TypedResult
< qpid::framing::ExchangeBoundResult
exchangeBound (const std::string &exchange=std::string(), const std::string &queue=std::string(), const std::string &bindingKey=std::string(), const FieldTable &arguments=FieldTable(), bool sync=false)
 
Completion queueDeclare (const std::string &queue=std::string(), const std::string &alternateExchange=std::string(), bool passive=false, bool durable=false, bool exclusive=false, bool autoDelete=false, const FieldTable &arguments=FieldTable(), bool sync=false)
 
Completion queueDelete (const std::string &queue=std::string(), bool ifUnused=false, bool ifEmpty=false, bool sync=false)
 
Completion queuePurge (const std::string &queue=std::string(), bool sync=false)
 
TypedResult
< qpid::framing::QueueQueryResult
queueQuery (const std::string &queue=std::string(), bool sync=false)
 
SessionId getId () const
 Get the session ID. More...
 
void close ()
 Close the session. More...
 
void sync ()
 Synchronize the session: sync() waits until all commands issued on this session so far have been completed by the broker. More...
 
uint32_t timeout (uint32_t seconds)
 Set the timeout for this session. More...
 
void suspend ()
 Suspend the session - detach it from its connection. More...
 
void resume (Connection)
 Resume a suspended session with a new connection. More...
 
uint16_t getChannel () const
 Get the channel associated with this session. More...
 
void flush ()
 
void markCompleted (const framing::SequenceSet &ids, bool notifyPeer)
 
void markCompleted (const framing::SequenceNumber &id, bool cumulative, bool notifyPeer)
 
void sendCompletion ()
 
bool isValid () const
 
Connection getConnection ()
 

Protected Attributes

boost::shared_ptr< SessionImpl > impl
 

Detailed Description

AMQP 0-10 asynchronous session API.

Definition at line 40 of file AsyncSession_0_10.h.

Constructor & Destructor Documentation

qpid::client::no_keyword::AsyncSession_0_10::AsyncSession_0_10 ( )
QPID_CLIENT_INLINE_EXTERN qpid::client::no_keyword::AsyncSession_0_10::AsyncSession_0_10 ( const SessionBase_0_10 other)

Member Function Documentation

void qpid::client::SessionBase_0_10::close ( )
inherited

Close the session.

A session is automatically closed when all handles to it are destroyed.

TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxCommit ( const Xid xid = Xid(),
bool  onePhase = false,
bool  sync = false 
)
TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxEnd ( const Xid xid = Xid(),
bool  fail = false,
bool  suspend = false,
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::dtxForget ( const Xid xid = Xid(),
bool  sync = false 
)
TypedResult<qpid::framing::DtxGetTimeoutResult> qpid::client::no_keyword::AsyncSession_0_10::dtxGetTimeout ( const Xid xid = Xid(),
bool  sync = false 
)
TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxPrepare ( const Xid xid = Xid(),
bool  sync = false 
)
TypedResult<qpid::framing::DtxRecoverResult> qpid::client::no_keyword::AsyncSession_0_10::dtxRecover ( bool  sync = false)
TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxRollback ( const Xid xid = Xid(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::dtxSelect ( bool  sync = false)
Completion qpid::client::no_keyword::AsyncSession_0_10::dtxSetTimeout ( const Xid xid = Xid(),
uint32_t  timeout = 0,
bool  sync = false 
)
TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxStart ( const Xid xid = Xid(),
bool  join = false,
bool  resume = false,
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::exchangeBind ( const std::string &  queue = std::string(),
const std::string &  exchange = std::string(),
const std::string &  bindingKey = std::string(),
const FieldTable arguments = FieldTable(),
bool  sync = false 
)
TypedResult<qpid::framing::ExchangeBoundResult> qpid::client::no_keyword::AsyncSession_0_10::exchangeBound ( const std::string &  exchange = std::string(),
const std::string &  queue = std::string(),
const std::string &  bindingKey = std::string(),
const FieldTable arguments = FieldTable(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::exchangeDeclare ( const std::string &  exchange = std::string(),
const std::string &  type = std::string(),
const std::string &  alternateExchange = std::string(),
bool  passive = false,
bool  durable = false,
bool  autoDelete = false,
const FieldTable arguments = FieldTable(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::exchangeDelete ( const std::string &  exchange = std::string(),
bool  ifUnused = false,
bool  sync = false 
)
TypedResult<qpid::framing::ExchangeQueryResult> qpid::client::no_keyword::AsyncSession_0_10::exchangeQuery ( const std::string &  name = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::exchangeUnbind ( const std::string &  queue = std::string(),
const std::string &  exchange = std::string(),
const std::string &  bindingKey = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::executionException ( uint16_t  errorCode = 0,
const SequenceNumber commandId = SequenceNumber(),
uint8_t  classCode = 0,
uint8_t  commandCode = 0,
uint8_t  fieldIndex = 0,
const std::string &  description = std::string(),
const FieldTable errorInfo = FieldTable(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::executionResult ( const SequenceNumber commandId = SequenceNumber(),
const std::string &  value = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::executionSync ( bool  sync = false)
void qpid::client::SessionBase_0_10::flush ( )
inherited
uint16_t qpid::client::SessionBase_0_10::getChannel ( ) const
inherited

Get the channel associated with this session.

Connection qpid::client::SessionBase_0_10::getConnection ( )
inherited
SessionId qpid::client::SessionBase_0_10::getId ( ) const
inherited

Get the session ID.

bool qpid::client::SessionBase_0_10::isValid ( ) const
inherited
void qpid::client::SessionBase_0_10::markCompleted ( const framing::SequenceSet ids,
bool  notifyPeer 
)
inherited
void qpid::client::SessionBase_0_10::markCompleted ( const framing::SequenceNumber id,
bool  cumulative,
bool  notifyPeer 
)
inherited
Completion qpid::client::no_keyword::AsyncSession_0_10::messageAccept ( const SequenceSet transfers = SequenceSet(),
bool  sync = false 
)
TypedResult<qpid::framing::MessageAcquireResult> qpid::client::no_keyword::AsyncSession_0_10::messageAcquire ( const SequenceSet transfers = SequenceSet(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageCancel ( const std::string &  destination = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageFlow ( const std::string &  destination = std::string(),
uint8_t  unit = 0,
uint32_t  value = 0,
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageFlush ( const std::string &  destination = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageReject ( const SequenceSet transfers = SequenceSet(),
uint16_t  code = 0,
const std::string &  text = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageRelease ( const SequenceSet transfers = SequenceSet(),
bool  setRedelivered = false,
bool  sync = false 
)
TypedResult<qpid::framing::MessageResumeResult> qpid::client::no_keyword::AsyncSession_0_10::messageResume ( const std::string &  destination = std::string(),
const std::string &  resumeId = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageSetFlowMode ( const std::string &  destination = std::string(),
uint8_t  flowMode = 0,
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageStop ( const std::string &  destination = std::string(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageSubscribe ( const std::string &  queue = std::string(),
const std::string &  destination = std::string(),
uint8_t  acceptMode = 0,
uint8_t  acquireMode = 0,
bool  exclusive = false,
const std::string &  resumeId = std::string(),
uint64_t  resumeTtl = 0,
const FieldTable arguments = FieldTable(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::messageTransfer ( const std::string &  destination = std::string(),
uint8_t  acceptMode = 1,
uint8_t  acquireMode = 0,
const Message content = Message(std::string()),
bool  sync = false 
)
QPID_CLIENT_INLINE_EXTERN AsyncSession_0_10& qpid::client::no_keyword::AsyncSession_0_10::operator= ( const SessionBase_0_10 other)
Completion qpid::client::no_keyword::AsyncSession_0_10::queueDeclare ( const std::string &  queue = std::string(),
const std::string &  alternateExchange = std::string(),
bool  passive = false,
bool  durable = false,
bool  exclusive = false,
bool  autoDelete = false,
const FieldTable arguments = FieldTable(),
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::queueDelete ( const std::string &  queue = std::string(),
bool  ifUnused = false,
bool  ifEmpty = false,
bool  sync = false 
)
Completion qpid::client::no_keyword::AsyncSession_0_10::queuePurge ( const std::string &  queue = std::string(),
bool  sync = false 
)
TypedResult<qpid::framing::QueueQueryResult> qpid::client::no_keyword::AsyncSession_0_10::queueQuery ( const std::string &  queue = std::string(),
bool  sync = false 
)
void qpid::client::SessionBase_0_10::resume ( Connection  )
inherited

Resume a suspended session with a new connection.

void qpid::client::SessionBase_0_10::sendCompletion ( )
inherited
void qpid::client::SessionBase_0_10::suspend ( )
inherited

Suspend the session - detach it from its connection.

void qpid::client::SessionBase_0_10::sync ( )
inherited

Synchronize the session: sync() waits until all commands issued on this session so far have been completed by the broker.

Note sync() is always synchronous, even on an AsyncSession object because that's almost always what you want. You can call AsyncSession::executionSync() directly in the unusual event that you want to do an asynchronous sync.

uint32_t qpid::client::SessionBase_0_10::timeout ( uint32_t  seconds)
inherited

Set the timeout for this session.

Completion qpid::client::no_keyword::AsyncSession_0_10::txCommit ( bool  sync = false)
Completion qpid::client::no_keyword::AsyncSession_0_10::txRollback ( bool  sync = false)
Completion qpid::client::no_keyword::AsyncSession_0_10::txSelect ( bool  sync = false)

Member Data Documentation

boost::shared_ptr<SessionImpl> qpid::client::SessionBase_0_10::impl
protectedinherited

The documentation for this class was generated from the following file:

Qpid C++ API Reference
Generated on Thu Mar 31 2016 for Qpid C++ Client API by doxygen 1.8.5