|
| Session_0_10 () |
|
QPID_CLIENT_INLINE_EXTERN | Session_0_10 (const SessionBase_0_10 &other) |
|
QPID_CLIENT_INLINE_EXTERN
Session_0_10 & | operator= (const SessionBase_0_10 &other) |
|
| BOOST_PARAMETER_MEMFUN (void, executionSync, 0, 1, ExecutionSyncParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, executionResult, 0, 3, ExecutionResultParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, executionException, 0, 8, ExecutionExceptionParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageTransfer, 0, 5, MessageTransferParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageAccept, 0, 2, MessageAcceptParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageReject, 0, 4, MessageRejectParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageRelease, 0, 3, MessageReleaseParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::MessageAcquireResult, messageAcquire, 0, 2, MessageAcquireParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::MessageResumeResult, messageResume, 0, 3, MessageResumeParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageSubscribe, 0, 9, MessageSubscribeParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageCancel, 0, 2, MessageCancelParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageSetFlowMode, 0, 3, MessageSetFlowModeParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageFlow, 0, 4, MessageFlowParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageFlush, 0, 2, MessageFlushParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, messageStop, 0, 2, MessageStopParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, txSelect, 0, 1, TxSelectParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, txCommit, 0, 1, TxCommitParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, txRollback, 0, 1, TxRollbackParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, dtxSelect, 0, 1, DtxSelectParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::XaResult, dtxStart, 0, 4, DtxStartParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::XaResult, dtxEnd, 0, 4, DtxEndParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::XaResult, dtxCommit, 0, 3, DtxCommitParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, dtxForget, 0, 2, DtxForgetParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::DtxGetTimeoutResult, dtxGetTimeout, 0, 2, DtxGetTimeoutParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::XaResult, dtxPrepare, 0, 2, DtxPrepareParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::DtxRecoverResult, dtxRecover, 0, 1, DtxRecoverParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::XaResult, dtxRollback, 0, 2, DtxRollbackParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, dtxSetTimeout, 0, 3, DtxSetTimeoutParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, exchangeDeclare, 0, 8, ExchangeDeclareParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, exchangeDelete, 0, 3, ExchangeDeleteParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::ExchangeQueryResult, exchangeQuery, 0, 2, ExchangeQueryParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, exchangeBind, 0, 5, ExchangeBindParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, exchangeUnbind, 0, 4, ExchangeUnbindParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::ExchangeBoundResult, exchangeBound, 0, 5, ExchangeBoundParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, queueDeclare, 0, 8, QueueDeclareParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, queueDelete, 0, 4, QueueDeleteParameters) |
|
| BOOST_PARAMETER_MEMFUN (void, queuePurge, 0, 2, QueuePurgeParameters) |
|
| BOOST_PARAMETER_MEMFUN (qpid::framing::QueueQueryResult, queueQuery, 0, 2, QueueQueryParameters) |
|
void | executionSync (bool sync=true) |
|
void | executionResult (const SequenceNumber &commandId=SequenceNumber(), const std::string &value=std::string(), bool sync=true) |
|
void | 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=true) |
|
void | messageTransfer (const std::string &destination=std::string(), uint8_t acceptMode=1, uint8_t acquireMode=0, const Message &content=Message(std::string()), bool sync=true) |
|
void | messageAccept (const SequenceSet &transfers=SequenceSet(), bool sync=true) |
|
void | messageReject (const SequenceSet &transfers=SequenceSet(), uint16_t code=0, const std::string &text=std::string(), bool sync=true) |
|
void | messageRelease (const SequenceSet &transfers=SequenceSet(), bool setRedelivered=false, bool sync=true) |
|
qpid::framing::MessageAcquireResult | messageAcquire (const SequenceSet &transfers=SequenceSet(), bool sync=true) |
|
qpid::framing::MessageResumeResult | messageResume (const std::string &destination=std::string(), const std::string &resumeId=std::string(), bool sync=true) |
|
void | 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=true) |
|
void | messageCancel (const std::string &destination=std::string(), bool sync=true) |
|
void | messageSetFlowMode (const std::string &destination=std::string(), uint8_t flowMode=0, bool sync=true) |
|
void | messageFlow (const std::string &destination=std::string(), uint8_t unit=0, uint32_t value=0, bool sync=true) |
|
void | messageFlush (const std::string &destination=std::string(), bool sync=true) |
|
void | messageStop (const std::string &destination=std::string(), bool sync=true) |
|
void | txSelect (bool sync=true) |
|
void | txCommit (bool sync=true) |
|
void | txRollback (bool sync=true) |
|
void | dtxSelect (bool sync=true) |
|
qpid::framing::XaResult | dtxStart (const Xid &xid=Xid(), bool join=false, bool resume=false, bool sync=true) |
|
qpid::framing::XaResult | dtxEnd (const Xid &xid=Xid(), bool fail=false, bool suspend=false, bool sync=true) |
|
qpid::framing::XaResult | dtxCommit (const Xid &xid=Xid(), bool onePhase=false, bool sync=true) |
|
void | dtxForget (const Xid &xid=Xid(), bool sync=true) |
|
qpid::framing::DtxGetTimeoutResult | dtxGetTimeout (const Xid &xid=Xid(), bool sync=true) |
|
qpid::framing::XaResult | dtxPrepare (const Xid &xid=Xid(), bool sync=true) |
|
qpid::framing::DtxRecoverResult | dtxRecover (bool sync=true) |
|
qpid::framing::XaResult | dtxRollback (const Xid &xid=Xid(), bool sync=true) |
|
void | dtxSetTimeout (const Xid &xid=Xid(), uint32_t timeout=0, bool sync=true) |
|
void | 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=true) |
|
void | exchangeDelete (const std::string &exchange=std::string(), bool ifUnused=false, bool sync=true) |
|
qpid::framing::ExchangeQueryResult | exchangeQuery (const std::string &name=std::string(), bool sync=true) |
|
void | 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=true) |
|
void | exchangeUnbind (const std::string &queue=std::string(), const std::string &exchange=std::string(), const std::string &bindingKey=std::string(), bool sync=true) |
|
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=true) |
|
void | 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=true) |
|
void | queueDelete (const std::string &queue=std::string(), bool ifUnused=false, bool ifEmpty=false, bool sync=true) |
|
void | queuePurge (const std::string &queue=std::string(), bool sync=true) |
|
qpid::framing::QueueQueryResult | queueQuery (const std::string &queue=std::string(), bool sync=true) |
|
AMQP 0-10 session API with keyword arguments.
This class provides the same set of functions as no_keyword::Session_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);
* session.foo(arg::z=3, arg::x=1);
*
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::Session_0_10 which provides the same set of functions using normal non-keyword declarations.
Publishing Messages
-
messageTransfer()
session.messageTransfer(arg::content=message, arg::destination="amq.topic");
-
messageTransfer() — asynchronous
#include <qpid/client/AsyncSession.h>
for (int i=0; i<10; i++) {
message.setData(message_data.str());
async(session).messageTransfer(arg::content=message, arg::destination="amq.direct");
}
session.sync();
Exchanges
-
exchangeBind()
session.exchangeBind(arg::exchange="amq.topic", arg::queue=queue, arg::bindingKey=routing_key);
-
exchangeUnbind()
session.exchangeUnBind(arg::exchange="amq.topic", arg::queue=queue, arg::bindingKey=routing_key);
-
exchangeBound()
if (session.exchangeBound(arg::exchange="amq.topic", arg::queue=queue, arg::bindingKey=rk)){...}
if (session.exchangeBound(arg::exchange="amq.topic", arg::queue=queue)){...}
-
exchangeDeclare()
session.exchangeDeclare(arg::exchange="my.topic", arg::type="topic");
session.exchangeDeclare(arg::exchange="xml", arg::type="xml");
-
exchangeDelete()
session.exchangeDeclare(arg::exchange="my.topic");
session.exchangeDeclare(arg::exchange="xml", arg::ifUnused=true);
-
exchangeQuery()
ExchangeQueryResult eqr = session.exchangeQuery(arg::exchange="my.topic");
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
-
queueDeclare()
session.queueDeclare(arg::queue="message_queue");
-
queueDelete()
session.queueDelete(arg::queue="message_queue");
-
queuePurge()
session.queuePurge(arg::queue="message_queue");
-
queueQuery()
QueueQueryResult qqr = session.queueQuery(arg::queue="message_queue");
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
-
messageAccept() — acknowledges messages
SequenceSet tobeAccepted;
toAccepted.add(msg.getId());
session.messageAccept(toBeAccepted);
-
messageAcquire()
SequenceSet tobeAcquired;
toBeAcquired.add(msg.getId());
session.messageAcquire(toBeAcquired);
-
messageReject()
SequenceSet tobeRejected;
toRejected.add(msg.getId());
session.messageReject(toBeRejected);
-
messageRelease()
SequenceSet tobeReleased;
toReleased.add(msg.getId());
session.messageRelease(toBeReleased);
Transactions
Definition at line 189 of file Session_0_10.h.