Apache Qpid C++ API
Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation

qpid::client::Session_0_10 Class Reference
[Qpid C++ Client API]

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

#include <Session_0_10.h>

List of all members.

Public Member Functions

 Session_0_10 ()
 Session_0_10 (const SessionBase_0_10 &other)
Session_0_10operator= (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)


Detailed Description

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);             // 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::Session_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 188 of file Session_0_10.h.


Constructor & Destructor Documentation

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

Definition at line 554 of file Session_0_10.h.

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

Definition at line 555 of file Session_0_10.h.


Member Function Documentation

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::QueueQueryResult  ,
queueQuery  ,
,
,
QueueQueryParameters   
) [inline]

Definition at line 544 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
queuePurge  ,
,
,
QueuePurgeParameters   
) [inline]

Definition at line 538 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
queueDelete  ,
,
,
QueueDeleteParameters   
) [inline]

Definition at line 530 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
queueDeclare  ,
,
,
QueueDeclareParameters   
) [inline]

Definition at line 518 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::ExchangeBoundResult  ,
exchangeBound  ,
,
,
ExchangeBoundParameters   
) [inline]

Definition at line 509 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
exchangeUnbind  ,
,
,
ExchangeUnbindParameters   
) [inline]

Definition at line 501 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
exchangeBind  ,
,
,
ExchangeBindParameters   
) [inline]

Definition at line 492 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::ExchangeQueryResult  ,
exchangeQuery  ,
,
,
ExchangeQueryParameters   
) [inline]

Definition at line 486 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
exchangeDelete  ,
,
,
ExchangeDeleteParameters   
) [inline]

Definition at line 479 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
exchangeDeclare  ,
,
,
ExchangeDeclareParameters   
) [inline]

Definition at line 467 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
dtxSetTimeout  ,
,
,
DtxSetTimeoutParameters   
) [inline]

Definition at line 460 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::XaResult  ,
dtxRollback  ,
,
,
DtxRollbackParameters   
) [inline]

Definition at line 454 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::DtxRecoverResult  ,
dtxRecover  ,
,
,
DtxRecoverParameters   
) [inline]

Definition at line 449 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::XaResult  ,
dtxPrepare  ,
,
,
DtxPrepareParameters   
) [inline]

Definition at line 443 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::DtxGetTimeoutResult  ,
dtxGetTimeout  ,
,
,
DtxGetTimeoutParameters   
) [inline]

Definition at line 437 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
dtxForget  ,
,
,
DtxForgetParameters   
) [inline]

Definition at line 431 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::XaResult  ,
dtxCommit  ,
,
,
DtxCommitParameters   
) [inline]

Definition at line 424 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::XaResult  ,
dtxEnd  ,
,
,
DtxEndParameters   
) [inline]

Definition at line 416 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::XaResult  ,
dtxStart  ,
,
,
DtxStartParameters   
) [inline]

Definition at line 408 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
dtxSelect  ,
,
,
DtxSelectParameters   
) [inline]

Definition at line 403 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
txRollback  ,
,
,
TxRollbackParameters   
) [inline]

Definition at line 398 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
txCommit  ,
,
,
TxCommitParameters   
) [inline]

Definition at line 393 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
txSelect  ,
,
,
TxSelectParameters   
) [inline]

Definition at line 388 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageStop  ,
,
,
MessageStopParameters   
) [inline]

Definition at line 382 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageFlush  ,
,
,
MessageFlushParameters   
) [inline]

Definition at line 376 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageFlow  ,
,
,
MessageFlowParameters   
) [inline]

Definition at line 368 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageSetFlowMode  ,
,
,
MessageSetFlowModeParameters   
) [inline]

Definition at line 361 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageCancel  ,
,
,
MessageCancelParameters   
) [inline]

Definition at line 355 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageSubscribe  ,
,
,
MessageSubscribeParameters   
) [inline]

Definition at line 342 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::MessageResumeResult  ,
messageResume  ,
,
,
MessageResumeParameters   
) [inline]

Definition at line 335 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( qpid::framing::MessageAcquireResult  ,
messageAcquire  ,
,
,
MessageAcquireParameters   
) [inline]

Definition at line 329 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageRelease  ,
,
,
MessageReleaseParameters   
) [inline]

Definition at line 322 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageReject  ,
,
,
MessageRejectParameters   
) [inline]

Definition at line 314 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageAccept  ,
,
,
MessageAcceptParameters   
) [inline]

Definition at line 308 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
messageTransfer  ,
,
,
MessageTransferParameters   
) [inline]

Definition at line 299 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
executionException  ,
,
,
ExecutionExceptionParameters   
) [inline]

Definition at line 287 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
executionResult  ,
,
,
ExecutionResultParameters   
) [inline]

Definition at line 280 of file Session_0_10.h.

References qpid::client::sync().

qpid::client::Session_0_10::BOOST_PARAMETER_MEMFUN ( void  ,
executionSync  ,
,
,
ExecutionSyncParameters   
) [inline]

Definition at line 275 of file Session_0_10.h.

References qpid::client::sync().

Session_0_10 & qpid::client::Session_0_10::operator= ( const SessionBase_0_10 other  )  [inline]

Definition at line 558 of file Session_0_10.h.


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

Qpid C++ API Reference
Generated on Thu Mar 19 15:24:03 2009 for Qpid C++ Client API by doxygen 1.5.7.1