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

AMQP 0-10 session API with keyword arguments. More...

#include <qpid/client/AsyncSession_0_10.h>

List of all members.

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)
 BOOST_PARAMETER_MEMFUN (Completion, executionSync, 0, 1, ExecutionSyncParameters)
 BOOST_PARAMETER_MEMFUN (Completion, executionResult, 0, 3, ExecutionResultParameters)
 BOOST_PARAMETER_MEMFUN (Completion, executionException, 0, 8, ExecutionExceptionParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageTransfer, 0, 5, MessageTransferParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageAccept, 0, 2, MessageAcceptParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageReject, 0, 4, MessageRejectParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageRelease, 0, 3, MessageReleaseParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::MessageAcquireResult >, messageAcquire, 0, 2, MessageAcquireParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::MessageResumeResult >, messageResume, 0, 3, MessageResumeParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageSubscribe, 0, 9, MessageSubscribeParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageCancel, 0, 2, MessageCancelParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageSetFlowMode, 0, 3, MessageSetFlowModeParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageFlow, 0, 4, MessageFlowParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageFlush, 0, 2, MessageFlushParameters)
 BOOST_PARAMETER_MEMFUN (Completion, messageStop, 0, 2, MessageStopParameters)
 BOOST_PARAMETER_MEMFUN (Completion, txSelect, 0, 1, TxSelectParameters)
 BOOST_PARAMETER_MEMFUN (Completion, txCommit, 0, 1, TxCommitParameters)
 BOOST_PARAMETER_MEMFUN (Completion, txRollback, 0, 1, TxRollbackParameters)
 BOOST_PARAMETER_MEMFUN (Completion, dtxSelect, 0, 1, DtxSelectParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::XaResult >, dtxStart, 0, 4, DtxStartParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::XaResult >, dtxEnd, 0, 4, DtxEndParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::XaResult >, dtxCommit, 0, 3, DtxCommitParameters)
 BOOST_PARAMETER_MEMFUN (Completion, dtxForget, 0, 2, DtxForgetParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::DtxGetTimeoutResult >, dtxGetTimeout, 0, 2, DtxGetTimeoutParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::XaResult >, dtxPrepare, 0, 2, DtxPrepareParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::DtxRecoverResult >, dtxRecover, 0, 1, DtxRecoverParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::XaResult >, dtxRollback, 0, 2, DtxRollbackParameters)
 BOOST_PARAMETER_MEMFUN (Completion, dtxSetTimeout, 0, 3, DtxSetTimeoutParameters)
 BOOST_PARAMETER_MEMFUN (Completion, exchangeDeclare, 0, 8, ExchangeDeclareParameters)
 BOOST_PARAMETER_MEMFUN (Completion, exchangeDelete, 0, 3, ExchangeDeleteParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::ExchangeQueryResult >, exchangeQuery, 0, 2, ExchangeQueryParameters)
 BOOST_PARAMETER_MEMFUN (Completion, exchangeBind, 0, 5, ExchangeBindParameters)
 BOOST_PARAMETER_MEMFUN (Completion, exchangeUnbind, 0, 4, ExchangeUnbindParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::ExchangeBoundResult >, exchangeBound, 0, 5, ExchangeBoundParameters)
 BOOST_PARAMETER_MEMFUN (Completion, queueDeclare, 0, 8, QueueDeclareParameters)
 BOOST_PARAMETER_MEMFUN (Completion, queueDelete, 0, 4, QueueDeleteParameters)
 BOOST_PARAMETER_MEMFUN (Completion, queuePurge, 0, 2, QueuePurgeParameters)
 BOOST_PARAMETER_MEMFUN (TypedResult< qpid::framing::QueueQueryResult >, queueQuery, 0, 2, QueueQueryParameters)
Completion executionSync (bool sync=false)
 This command is complete when all prior commands are completed.
Completion executionResult (const SequenceNumber &commandId=SequenceNumber(), const std::string &value=std::string(), bool sync=false)
 This command carries data resulting from the execution of a command.
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)
 This command informs a peer of an execution exception.
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)
 This command transfers a message between two peers.
Completion messageAccept (const SequenceSet &transfers=SequenceSet(), bool sync=false)
 Accepts the message.
Completion messageReject (const SequenceSet &transfers=SequenceSet(), uint16_t code=0, const std::string &text=std::string(), bool sync=false)
 Indicates that the message transfers are unprocessable in some way.
Completion messageRelease (const SequenceSet &transfers=SequenceSet(), bool setRedelivered=false, bool sync=false)
 Release previously transferred messages.
TypedResult
< qpid::framing::MessageAcquireResult
messageAcquire (const SequenceSet &transfers=SequenceSet(), bool sync=false)
 Acquires previously transferred messages for consumption.
TypedResult
< qpid::framing::MessageResumeResult
messageResume (const std::string &destination=std::string(), const std::string &resumeId=std::string(), bool sync=false)
 This command resumes an interrupted transfer.
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)
 This command asks the server to start a "subscription", which is a request for messages from a specific queue.
Completion messageCancel (const std::string &destination=std::string(), bool sync=false)
 This command cancels a subscription.
Completion messageSetFlowMode (const std::string &destination=std::string(), uint8_t flowMode=0, bool sync=false)
 Sets the mode of flow control used for a given destination to either window or credit based flow control.
Completion messageFlow (const std::string &destination=std::string(), uint8_t unit=0, uint32_t value=0, bool sync=false)
 This command controls the flow of message data to a given destination.
Completion messageFlush (const std::string &destination=std::string(), bool sync=false)
 Forces the sender to exhaust his credit supply.
Completion messageStop (const std::string &destination=std::string(), bool sync=false)
 On receipt of this command, a producer of messages MUST set his credit to zero for the given destination.
Completion txSelect (bool sync=false)
 This command sets the session to use standard transactions.
Completion txCommit (bool sync=false)
 This command commits all messages published and accepted in the current transaction.
Completion txRollback (bool sync=false)
 This command abandons the current transaction.
Completion dtxSelect (bool sync=false)
 This command sets the session to use distributed transactions.
TypedResult
< qpid::framing::XaResult
dtxStart (const Xid &xid=Xid(), bool join=false, bool resume=false, bool sync=false)
 This command is called when messages should be produced and consumed on behalf a transaction branch identified by xid.
TypedResult
< qpid::framing::XaResult
dtxEnd (const Xid &xid=Xid(), bool fail=false, bool suspend=false, bool sync=false)
 This command is called when the work done on behalf a transaction branch finishes or needs to be suspended.
TypedResult
< qpid::framing::XaResult
dtxCommit (const Xid &xid=Xid(), bool onePhase=false, bool sync=false)
 Commit the work done on behalf a transaction branch.
Completion dtxForget (const Xid &xid=Xid(), bool sync=false)
 This command is called to forget about a heuristically completed transaction branch.
TypedResult
< qpid::framing::DtxGetTimeoutResult
dtxGetTimeout (const Xid &xid=Xid(), bool sync=false)
 This command obtains the current transaction timeout value in seconds.
TypedResult
< qpid::framing::XaResult
dtxPrepare (const Xid &xid=Xid(), bool sync=false)
 This command prepares for commitment any message produced or consumed on behalf of xid.
TypedResult
< qpid::framing::DtxRecoverResult
dtxRecover (bool sync=false)
 This command is called to obtain a list of transaction branches that are in a prepared or heuristically completed state.
TypedResult
< qpid::framing::XaResult
dtxRollback (const Xid &xid=Xid(), bool sync=false)
 This command rolls back the work associated with xid.
Completion dtxSetTimeout (const Xid &xid=Xid(), uint32_t timeout=0, bool sync=false)
 Sets the specified transaction branch timeout value in seconds.
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)
 This command creates an exchange if it does not already exist, and if the exchange exists, verifies that it is of the correct and expected class.
Completion exchangeDelete (const std::string &exchange=std::string(), bool ifUnused=false, bool sync=false)
 This command deletes an exchange.
TypedResult
< qpid::framing::ExchangeQueryResult
exchangeQuery (const std::string &name=std::string(), bool sync=false)
 This command is used to request information on a particular exchange.
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)
 This command binds a queue to an exchange.
Completion exchangeUnbind (const std::string &queue=std::string(), const std::string &exchange=std::string(), const std::string &bindingKey=std::string(), bool sync=false)
 This command unbinds a queue from an exchange.
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)
 This command is used to request information on the bindings to a particular exchange.
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)
 This command creates or checks a queue.
Completion queueDelete (const std::string &queue=std::string(), bool ifUnused=false, bool ifEmpty=false, bool sync=false)
 This command deletes a queue.
Completion queuePurge (const std::string &queue=std::string(), bool sync=false)
 This command removes all messages from a queue.
TypedResult
< qpid::framing::QueueQueryResult
queueQuery (const std::string &queue=std::string(), bool sync=false)
 This command requests information about a queue.
SessionId getId () const
 Get the session ID.
void close ()
 Close the session.
void sync ()
 Synchronize the session: sync() waits until all commands issued on this session so far have been completed by the broker.
uint32_t timeout (uint32_t seconds)
 Set the timeout for this session.
void suspend ()
 Suspend the session - detach it from its connection.
void resume (Connection)
 Resume a suspended session with a new connection.
uint16_t getChannel () const
 Get the channel associated with this session.
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 session API with keyword arguments.

This class provides the same set of functions as no_keyword::AsyncSession_0_10, but also allows parameters be passed using keywords. The keyword is the parameter name in the namespace "arg".

For example given the normal function "foo(int x=0, int y=0, int z=0)" you could call it in either of the following ways:

 session.foo(1,2,3);             // Normal no keywords
 session.foo(arg::z=3, arg::x=1); // Keywords and a default

The keyword functions are easy to use but their declarations are hard to read. You may find it easier to read the documentation for no_keyword::AsyncSession_0_10 which provides the same set of functions using normal non-keyword declarations.

Publishing Messages

Exchanges

Configuring exchanges in session.exchangeDeclare

arg::durable=true

Default: false.

If durable=true, an exchange remains active even if the server is restarted. If durable=false, an exchange is purged when a server restarts.

arg::autoDelete=true

Default: false.

If autoDelete=true, deleting the last binding for an exchange also deletes the exchange.

arg::alternatExchange="my.exchange"

Default: none.

If an alternate exchange is specified, messages that can not be delivered to any queue are sent to the alternate exchange.

Queues

Configuring queues with session.queueDeclare

arg::durable=true

Default: false.

If durable=true, a queue remains active if the server is restarted. If durable=false, a queue and its contents are lost when a server restarts.

arg::autoDelete=true

Default: false.

If autoDelete=true, the queue is deleted when the last active Subscription to the Queue is canceled.

arg::exclusive=true

Default: false.

If exclusive=true, only the Session that created a queue can access it.

arg::alternateExchange="my.exchange"

Default: none.

If an alternate exchange is specified, messages are routed to it if (1) they are rejected by a client, or (2) they remain on the queue when it is deleted.

Accepting, Acquiring, Rejecting, or Releasing Messages

Transactions

Definition at line 189 of file AsyncSession_0_10.h.


Constructor & Destructor Documentation

qpid::client::AsyncSession_0_10::AsyncSession_0_10 ( ) [inline]

Reimplemented from qpid::client::no_keyword::AsyncSession_0_10.

Definition at line 555 of file AsyncSession_0_10.h.

qpid::client::AsyncSession_0_10::AsyncSession_0_10 ( const SessionBase_0_10 other) [inline]

Reimplemented from qpid::client::no_keyword::AsyncSession_0_10.

Definition at line 556 of file AsyncSession_0_10.h.


Member Function Documentation

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
executionSync  ,
,
,
ExecutionSyncParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
executionException  ,
,
,
ExecutionExceptionParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageRelease  ,
,
,
MessageReleaseParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageStop  ,
,
,
MessageStopParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::ExchangeQueryResult ,
exchangeQuery  ,
,
,
ExchangeQueryParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
exchangeBind  ,
,
,
ExchangeBindParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
txSelect  ,
,
,
TxSelectParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
exchangeUnbind  ,
,
,
ExchangeUnbindParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::ExchangeBoundResult ,
exchangeBound  ,
,
,
ExchangeBoundParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::MessageAcquireResult ,
messageAcquire  ,
,
,
MessageAcquireParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
txCommit  ,
,
,
TxCommitParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
queueDeclare  ,
,
,
QueueDeclareParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
queueDelete  ,
,
,
QueueDeleteParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
txRollback  ,
,
,
TxRollbackParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
queuePurge  ,
,
,
QueuePurgeParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::QueueQueryResult ,
queueQuery  ,
,
,
QueueQueryParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageTransfer  ,
,
,
MessageTransferParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::MessageResumeResult ,
messageResume  ,
,
,
MessageResumeParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
dtxSelect  ,
,
,
DtxSelectParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::XaResult ,
dtxStart  ,
,
,
DtxStartParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageSubscribe  ,
,
,
MessageSubscribeParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::XaResult ,
dtxEnd  ,
,
,
DtxEndParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::XaResult ,
dtxCommit  ,
,
,
DtxCommitParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
executionResult  ,
,
,
ExecutionResultParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageAccept  ,
,
,
MessageAcceptParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageCancel  ,
,
,
MessageCancelParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
dtxForget  ,
,
,
DtxForgetParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::DtxGetTimeoutResult ,
dtxGetTimeout  ,
,
,
DtxGetTimeoutParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageSetFlowMode  ,
,
,
MessageSetFlowModeParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::XaResult ,
dtxPrepare  ,
,
,
DtxPrepareParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::DtxRecoverResult ,
dtxRecover  ,
,
,
DtxRecoverParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageReject  ,
,
,
MessageRejectParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageFlow  ,
,
,
MessageFlowParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( TypedResult< qpid::framing::XaResult ,
dtxRollback  ,
,
,
DtxRollbackParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
dtxSetTimeout  ,
,
,
DtxSetTimeoutParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
messageFlush  ,
,
,
MessageFlushParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
exchangeDeclare  ,
,
,
ExchangeDeclareParameters   
) [inline]
qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN ( Completion  ,
exchangeDelete  ,
,
,
ExchangeDeleteParameters   
) [inline]
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 
) [inherited]

Commit the work done on behalf a transaction branch.

This command commits the work associated with xid. Any produced messages are made available and any consumed messages are discarded.

Parameters:
xidSpecifies the xid of the transaction branch to be committed.
onePhaseUsed to indicate whether one-phase or two-phase commit is used.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command is called when the work done on behalf a transaction branch finishes or needs to be suspended.

Parameters:
xidSpecifies the xid of the transaction branch to be ended.
failIf set, indicates that this portion of work has failed; otherwise this portion of work has completed successfully.
suspendIndicates that the transaction branch is temporarily suspended in an incomplete state.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::dtxForget ( const Xid &  xid = Xid(),
bool  sync = false 
) [inherited]

This command is called to forget about a heuristically completed transaction branch.

Parameters:
xidSpecifies the xid of the transaction branch to be forgotten.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::DtxGetTimeoutResult> qpid::client::no_keyword::AsyncSession_0_10::dtxGetTimeout ( const Xid &  xid = Xid(),
bool  sync = false 
) [inherited]

This command obtains the current transaction timeout value in seconds.

If set-timeout was not used prior to invoking this command, the return value is the default timeout; otherwise, the value used in the previous set-timeout call is returned.

Parameters:
xidSpecifies the xid of the transaction branch for getting the timeout.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxPrepare ( const Xid &  xid = Xid(),
bool  sync = false 
) [inherited]

This command prepares for commitment any message produced or consumed on behalf of xid.

Parameters:
xidSpecifies the xid of the transaction branch that can be prepared.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::DtxRecoverResult> qpid::client::no_keyword::AsyncSession_0_10::dtxRecover ( bool  sync = false) [inherited]

This command is called to obtain a list of transaction branches that are in a prepared or heuristically completed state.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::XaResult> qpid::client::no_keyword::AsyncSession_0_10::dtxRollback ( const Xid &  xid = Xid(),
bool  sync = false 
) [inherited]

This command rolls back the work associated with xid.

Any produced messages are discarded and any consumed messages are re-enqueued.

Parameters:
xidSpecifies the xid of the transaction branch that can be rolled back.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::dtxSelect ( bool  sync = false) [inherited]

This command sets the session to use distributed transactions.

The client must use this command at least once on a session before using XA demarcation operations.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::dtxSetTimeout ( const Xid &  xid = Xid(),
uint32_t  timeout = 0,
bool  sync = false 
) [inherited]

Sets the specified transaction branch timeout value in seconds.

Parameters:
xidSpecifies the xid of the transaction branch for setting the timeout.
timeoutThe transaction timeout value in seconds.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command is called when messages should be produced and consumed on behalf a transaction branch identified by xid.

Parameters:
xidSpecifies the xid of the transaction branch to be started.
joinIndicate whether this is joining an already associated xid. Indicate that the start applies to joining a transaction previously seen.
resumeIndicate that the start applies to resuming a suspended transaction branch specified.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command binds a queue to an exchange.

Until a queue is bound it will not receive any messages. In a classic messaging model, store-and-forward queues are bound to a direct exchange and subscription queues are bound to a topic exchange.

Parameters:
queueSpecifies the name of the queue to bind.
exchange
bindingKeyThe binding-key uniquely identifies a binding between a given (exchange, queue) pair. Depending on the exchange configuration, the binding key may be matched against the message routing key in order to make routing decisions. The match algorithm depends on the exchange type. Some exchange types may ignore the binding key when making routing decisions. Refer to the specific exchange type documentation. The meaning of an empty binding key depends on the exchange implementation.
argumentsA set of arguments for the binding. The syntax and semantics of these arguments depends on the exchange class.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command is used to request information on the bindings to a particular exchange.

Parameters:
exchangeThe name of the exchange for which binding information is being requested. If not specified explicitly the default exchange is implied.
queueIf populated then determine whether the given queue is bound to the exchange.
bindingKeyIf populated defines the binding-key of the binding of interest, if not populated the request will ignore the binding-key on bindings when searching for a match.
argumentsIf populated defines the arguments of the binding of interest if not populated the request will ignore the arguments on bindings when searching for a match
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command creates an exchange if it does not already exist, and if the exchange exists, verifies that it is of the correct and expected class.

Parameters:
exchange
typeEach exchange belongs to one of a set of exchange types implemented by the server. The exchange types define the functionality of the exchange - i.e. how messages are routed through it. It is not valid or meaningful to attempt to change the type of an existing exchange.
alternateExchangeIn the event that a message cannot be routed, this is the name of the exchange to which the message will be sent. Messages transferred using message.transfer will be routed to the alternate-exchange only if they are sent with the "none" accept-mode, and the discard-unroutable delivery property is set to false, and there is no queue to route to for the given message according to the bindings on this exchange.
passiveIf set, the server will not create the exchange. The client can use this to check whether an exchange exists without modifying the server state.
durableIf set when creating a new exchange, the exchange will be marked as durable. Durable exchanges remain active when a server restarts. Non-durable exchanges (transient exchanges) are purged if/when a server restarts.
autoDeleteIf set, the exchange is deleted automatically when there remain no bindings between the exchange and any queue. Such an exchange will not be automatically deleted until at least one binding has been made to prevent the immediate deletion of the exchange upon creation.
argumentsA set of arguments for the declaration. The syntax and semantics of these arguments depends on the server implementation. This field is ignored if passive is 1.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::exchangeDelete ( const std::string &  exchange = std::string(),
bool  ifUnused = false,
bool  sync = false 
) [inherited]

This command deletes an exchange.

When an exchange is deleted all queue bindings on the exchange are cancelled.

Parameters:
exchange
ifUnusedIf set, the server will only delete the exchange if it has no queue bindings. If the exchange has queue bindings the server does not delete it but raises an exception instead.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::ExchangeQueryResult> qpid::client::no_keyword::AsyncSession_0_10::exchangeQuery ( const std::string &  name = std::string(),
bool  sync = false 
) [inherited]

This command is used to request information on a particular exchange.

Parameters:
nameThe name of the exchange for which information is requested. If not specified explicitly the default exchange is implied.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command unbinds a queue from an exchange.

Parameters:
queueSpecifies the name of the queue to unbind.
exchangeThe name of the exchange to unbind from.
bindingKeySpecifies the binding-key of the binding to unbind.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command informs a peer of an execution exception.

The command-id, when given, correlates the error to a specific command.

Parameters:
errorCode
commandIdThe command-id of the command which caused the exception. If the exception was not caused by a specific command, this value is not set.
classCode
commandCode
fieldIndexThe zero based index of the exceptional field within the arguments to the exceptional command. If the exception was not caused by a specific field, this value is not set.
descriptionThe description provided is implementation defined, but MUST be in the language appropriate for the selected locale. The intention is that this description is suitable for logging or alerting output.
errorInfo
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::executionResult ( const SequenceNumber &  commandId = SequenceNumber(),
const std::string &  value = std::string(),
bool  sync = false 
) [inherited]

This command carries data resulting from the execution of a command.

Parameters:
commandId
value
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::executionSync ( bool  sync = false) [inherited]

This command is complete when all prior commands are completed.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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::SequenceNumber id,
bool  cumulative,
bool  notifyPeer 
) [inherited]
void qpid::client::SessionBase_0_10::markCompleted ( const framing::SequenceSet ids,
bool  notifyPeer 
) [inherited]
Completion qpid::client::no_keyword::AsyncSession_0_10::messageAccept ( const SequenceSet &  transfers = SequenceSet(),
bool  sync = false 
) [inherited]

Accepts the message.

Once a transfer is accepted, the command-id may no longer be referenced from other commands.

Parameters:
transfersIdentifies the messages previously transferred that should be accepted.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::MessageAcquireResult> qpid::client::no_keyword::AsyncSession_0_10::messageAcquire ( const SequenceSet &  transfers = SequenceSet(),
bool  sync = false 
) [inherited]

Acquires previously transferred messages for consumption.

The acquired ids (if any) are sent via message.acquired.

Parameters:
transfersIndicates the messages to be acquired.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::messageCancel ( const std::string &  destination = std::string(),
bool  sync = false 
) [inherited]

This command cancels a subscription.

This does not affect already delivered messages, but it does mean the server will not send any more messages for that subscription. The client may receive an arbitrary number of messages in between sending the cancel command and receiving notification that the cancel command is complete.

Parameters:
destination
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command controls the flow of message data to a given destination.

It is used by the recipient of messages to dynamically match the incoming rate of message flow to its processing or forwarding capacity. Upon receipt of this command, the sender must add "value" number of the specified unit to the available credit balance for the specified destination. A value of (0xFFFFFFFF) indicates an infinite amount of credit. This disables any limit for the given unit until the credit balance is zeroed with message.stop or message.flush.

Parameters:
destination
unitThe unit of value.
valueIf the value is not set then this indicates an infinite amount of credit.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::messageFlush ( const std::string &  destination = std::string(),
bool  sync = false 
) [inherited]

Forces the sender to exhaust his credit supply.

The sender's credit will always be zero when this command completes. The command completes when immediately available message data has been transferred, or when the credit supply is exhausted.

Parameters:
destination
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

Indicates that the message transfers are unprocessable in some way.

A server may reject a message if it is unroutable. A client may reject a message if it is invalid. A message may be rejected for other reasons as well. Once a transfer is rejected, the command-id may no longer be referenced from other commands.

Parameters:
transfersIdentifies the messages previously transferred that should be rejected.
codeCode describing the reason for rejection.
textText describing the reason for rejection.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::messageRelease ( const SequenceSet &  transfers = SequenceSet(),
bool  setRedelivered = false,
bool  sync = false 
) [inherited]

Release previously transferred messages.

When acquired messages are released, they become available for acquisition by any subscriber. Once a transfer is released, the command-id may no longer be referenced from other commands.

Parameters:
transfersIndicates the messages to be released.
setRedeliveredBy setting set-redelivered to true, any acquired messages released to a queue with this command will be marked as redelivered on their next transfer from that queue. If this flag is not set, then an acquired message will retain its original redelivered status on the queue. Messages that are not acquired are unaffected by the value of this flag.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command resumes an interrupted transfer.

The recipient should return the amount of partially transferred data associated with the given resume-id, or zero if there is no data at all. If a non-zero result is returned, the recipient should expect to receive message fragment(s) containing the remainder of the interrupted message.

Parameters:
destinationThe destination to which the remaining message fragments are transferred.
resumeIdThe name of the transfer being resumed.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::messageSetFlowMode ( const std::string &  destination = std::string(),
uint8_t  flowMode = 0,
bool  sync = false 
) [inherited]

Sets the mode of flow control used for a given destination to either window or credit based flow control.

With credit based flow control, the sender of messages continually maintains its current credit balance with the recipient. The credit balance consists of two values, a message count, and a byte count. Whenever message data is sent, both counts must be decremented. If either value reaches zero, the flow of message data must stop. Additional credit is received via the message.flow command.

The sender MUST NOT send partial assemblies. This means that if there is not enough byte credit available to send a complete message, the sender must either wait or use message fragmentation (see the fragment-properties header struct) to send the first part of the message data in a complete assembly.

Window based flow control is identical to credit based flow control, however message transfer completion implicitly grants a single unit of message credit, and the size of the message in byte credits for each completed message transfer. Completion of the transfer command with session.completed is the only way credit is implicitly updated; message.accept, message.release, message.reject, tx.commit and tx.rollback have no effect on the outstanding credit balances.

Parameters:
destination
flowModeThe new flow control mode.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::messageStop ( const std::string &  destination = std::string(),
bool  sync = false 
) [inherited]

On receipt of this command, a producer of messages MUST set his credit to zero for the given destination.

When notifying of completion, credit MUST be zero and no further messages will be sent until such a time as further credit is received.

Parameters:
destination
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command asks the server to start a "subscription", which is a request for messages from a specific queue.

Subscriptions last as long as the session they were created on, or until the client cancels them.

Parameters:
queueSpecifies the name of the subscribed queue.
destinationThe client specified name for the subscription. This is used as the destination for all messages transferred from this subscription. The destination is scoped to the session.
acceptModeThe accept-mode to use for messages transferred from this subscription.
acquireModeThe acquire-mode to use for messages transferred from this subscription.
exclusiveRequest an exclusive subscription. This prevents other subscribers from subscribing to the queue.
resumeIdRequests that the broker use the supplied resume-id when transferring messages for this subscription.
resumeTtlRequested duration in milliseconds for the broker use as resume-ttl when transferring messages for this subscription.
argumentsThe syntax and semantics of these arguments depends on the providers implementation.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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 
) [inherited]

This command transfers a message between two peers.

When a client uses this command to publish a message to a broker, the destination identifies a specific exchange. The message will then be routed to queues as defined by the exchange configuration.

The client may request a broker to transfer messages to it, from a particular queue, by issuing a subscribe command. The subscribe command specifies the destination that the broker should use for any resulting transfers.

Parameters:
destinationSpecifies the destination to which the message is to be transferred.
acceptModeIndicates whether message.accept, session.complete, or nothing at all is required to indicate successful transfer of the message.
acquireModeIndicates whether or not the transferred message has been acquired.
contentMessage content
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

AsyncSession_0_10 & qpid::client::AsyncSession_0_10::operator= ( const SessionBase_0_10 other) [inline]
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 
) [inherited]

This command creates or checks a queue.

When creating a new queue the client can specify various properties that control the durability of the queue and its contents, and the level of sharing for the queue.

Parameters:
queue
alternateExchangeThe alternate-exchange field specifies how messages on this queue should be treated when they are rejected by a subscriber, or when they are orphaned by queue deletion. When present, rejected or orphaned messages MUST be routed to the alternate-exchange. In all cases the messages MUST be removed from the queue.
passiveIf set, the server will not create the queue. This field allows the client to assert the presence of a queue without modifying the server state.
durableIf set when creating a new queue, the queue will be marked as durable. Durable queues remain active when a server restarts. Non-durable queues (transient queues) are purged if/when a server restarts. Note that durable queues do not necessarily hold persistent messages, although it does not make sense to send persistent messages to a transient queue.
exclusiveExclusive queues can only be used from one session at a time. Once a session declares an exclusive queue, that queue cannot be used by any other session until the declaring session closes.
autoDeleteIf this field is set and the exclusive field is also set, then the queue MUST be deleted when the session closes.

If this field is set and the exclusive field is not set the queue is deleted when all the consumers have finished using it. Last consumer can be cancelled either explicitly or because its session is closed. If there was no consumer ever on the queue, it won't be deleted.

Parameters:
argumentsA set of arguments for the declaration. The syntax and semantics of these arguments depends on the server implementation. This field is ignored if passive is 1.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::queueDelete ( const std::string &  queue = std::string(),
bool  ifUnused = false,
bool  ifEmpty = false,
bool  sync = false 
) [inherited]

This command deletes a queue.

When a queue is deleted any pending messages are sent to the alternate-exchange if defined, or discarded if it is not.

Parameters:
queueSpecifies the name of the queue to delete.
ifUnusedIf set, the server will only delete the queue if it has no consumers. If the queue has consumers the server does does not delete it but raises an exception instead.
ifEmptyIf set, the server will only delete the queue if it has no messages.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::queuePurge ( const std::string &  queue = std::string(),
bool  sync = false 
) [inherited]

This command removes all messages from a queue.

It does not cancel subscribers. Purged messages are deleted without any formal "undo" mechanism.

Parameters:
queueSpecifies the name of the queue to purge.
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

TypedResult<qpid::framing::QueueQueryResult> qpid::client::no_keyword::AsyncSession_0_10::queueQuery ( const std::string &  queue = std::string(),
bool  sync = false 
) [inherited]

This command requests information about a queue.

Parameters:
queue
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

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) [inherited]

This command commits all messages published and accepted in the current transaction.

A new transaction starts immediately after a commit.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::txRollback ( bool  sync = false) [inherited]

This command abandons the current transaction.

In particular the transfers from Client to Server (publishes) and accepts of transfers from Server to Client which occurred in the current transaction are discarded. A new transaction starts immediately after a rollback.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().

Completion qpid::client::no_keyword::AsyncSession_0_10::txSelect ( bool  sync = false) [inherited]

This command sets the session to use standard transactions.

The client must use this command exactly once on a session before using the Commit or Rollback commands.

Parameters:
syncIf true the broker will respond with completion status as soon as possible.

Referenced by BOOST_PARAMETER_MEMFUN().


Member Data Documentation

boost::shared_ptr<SessionImpl> qpid::client::SessionBase_0_10::impl [protected, inherited]

Definition at line 104 of file SessionBase_0_10.h.

Referenced by qpid::client::Session_0_10::operator=(), and operator=().


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

Qpid C++ API Reference
Generated on Mon Aug 22 2011 for Qpid C++ Client API by doxygen 1.7.4