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

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

#include <AsyncSession_0_10.h>

List of all members.

Public Member Functions
	AsyncSession_0_10 ()
	AsyncSession_0_10 (const SessionBase_0_10 &other)
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)

---

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

• 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

• txSelect()

  session.txSelect();

• txCommit()

  session.txSelect();

• txRollback()

  session.txRollback();

Definition at line 188 of file AsyncSession_0_10.h.

---

Constructor & Destructor Documentation

qpid::client::AsyncSession_0_10::AsyncSession_0_10

(

)

[inline]

Definition at line 554 of file AsyncSession_0_10.h.

qpid::client::AsyncSession_0_10::AsyncSession_0_10

(

const SessionBase_0_10 &

other

)

[inline]

Definition at line 555 of file AsyncSession_0_10.h.

---

Member Function Documentation

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::QueueQueryResult >	,
		queueQuery	,
		0	,
		2	,
		QueueQueryParameters
	)			[inline]

Definition at line 544 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		queuePurge	,
		0	,
		2	,
		QueuePurgeParameters
	)			[inline]

Definition at line 538 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		queueDelete	,
		0	,
		4	,
		QueueDeleteParameters
	)			[inline]

Definition at line 530 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		queueDeclare	,
		0	,
		8	,
		QueueDeclareParameters
	)			[inline]

Definition at line 518 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::ExchangeBoundResult >	,
		exchangeBound	,
		0	,
		5	,
		ExchangeBoundParameters
	)			[inline]

Definition at line 509 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		exchangeUnbind	,
		0	,
		4	,
		ExchangeUnbindParameters
	)			[inline]

Definition at line 501 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		exchangeBind	,
		0	,
		5	,
		ExchangeBindParameters
	)			[inline]

Definition at line 492 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::ExchangeQueryResult >	,
		exchangeQuery	,
		0	,
		2	,
		ExchangeQueryParameters
	)			[inline]

Definition at line 486 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		exchangeDelete	,
		0	,
		3	,
		ExchangeDeleteParameters
	)			[inline]

Definition at line 479 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		exchangeDeclare	,
		0	,
		8	,
		ExchangeDeclareParameters
	)			[inline]

Definition at line 467 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		dtxSetTimeout	,
		0	,
		3	,
		DtxSetTimeoutParameters
	)			[inline]

Definition at line 460 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::XaResult >	,
		dtxRollback	,
		0	,
		2	,
		DtxRollbackParameters
	)			[inline]

Definition at line 454 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::DtxRecoverResult >	,
		dtxRecover	,
		0	,
		1	,
		DtxRecoverParameters
	)			[inline]

Definition at line 449 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::XaResult >	,
		dtxPrepare	,
		0	,
		2	,
		DtxPrepareParameters
	)			[inline]

Definition at line 443 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::DtxGetTimeoutResult >	,
		dtxGetTimeout	,
		0	,
		2	,
		DtxGetTimeoutParameters
	)			[inline]

Definition at line 437 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		dtxForget	,
		0	,
		2	,
		DtxForgetParameters
	)			[inline]

Definition at line 431 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::XaResult >	,
		dtxCommit	,
		0	,
		3	,
		DtxCommitParameters
	)			[inline]

Definition at line 424 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::XaResult >	,
		dtxEnd	,
		0	,
		4	,
		DtxEndParameters
	)			[inline]

Definition at line 416 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::XaResult >	,
		dtxStart	,
		0	,
		4	,
		DtxStartParameters
	)			[inline]

Definition at line 408 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		dtxSelect	,
		0	,
		1	,
		DtxSelectParameters
	)			[inline]

Definition at line 403 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		txRollback	,
		0	,
		1	,
		TxRollbackParameters
	)			[inline]

Definition at line 398 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		txCommit	,
		0	,
		1	,
		TxCommitParameters
	)			[inline]

Definition at line 393 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		txSelect	,
		0	,
		1	,
		TxSelectParameters
	)			[inline]

Definition at line 388 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageStop	,
		0	,
		2	,
		MessageStopParameters
	)			[inline]

Definition at line 382 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageFlush	,
		0	,
		2	,
		MessageFlushParameters
	)			[inline]

Definition at line 376 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageFlow	,
		0	,
		4	,
		MessageFlowParameters
	)			[inline]

Definition at line 368 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageSetFlowMode	,
		0	,
		3	,
		MessageSetFlowModeParameters
	)			[inline]

Definition at line 361 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageCancel	,
		0	,
		2	,
		MessageCancelParameters
	)			[inline]

Definition at line 355 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageSubscribe	,
		0	,
		9	,
		MessageSubscribeParameters
	)			[inline]

Definition at line 342 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::MessageResumeResult >	,
		messageResume	,
		0	,
		3	,
		MessageResumeParameters
	)			[inline]

Definition at line 335 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	TypedResult< qpid::framing::MessageAcquireResult >	,
		messageAcquire	,
		0	,
		2	,
		MessageAcquireParameters
	)			[inline]

Definition at line 329 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageRelease	,
		0	,
		3	,
		MessageReleaseParameters
	)			[inline]

Definition at line 322 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageReject	,
		0	,
		4	,
		MessageRejectParameters
	)			[inline]

Definition at line 314 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageAccept	,
		0	,
		2	,
		MessageAcceptParameters
	)			[inline]

Definition at line 308 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		messageTransfer	,
		0	,
		5	,
		MessageTransferParameters
	)			[inline]

Definition at line 299 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		executionException	,
		0	,
		8	,
		ExecutionExceptionParameters
	)			[inline]

Definition at line 287 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		executionResult	,
		0	,
		3	,
		ExecutionResultParameters
	)			[inline]

Definition at line 280 of file AsyncSession_0_10.h.

References qpid::client::sync().

qpid::client::AsyncSession_0_10::BOOST_PARAMETER_MEMFUN	(	Completion	,
		executionSync	,
		0	,
		1	,
		ExecutionSyncParameters
	)			[inline]

Definition at line 275 of file AsyncSession_0_10.h.

References qpid::client::sync().

AsyncSession_0_10 & qpid::client::AsyncSession_0_10::operator=

(

const SessionBase_0_10 &

other

)

[inline]

Definition at line 558 of file AsyncSession_0_10.h.

---

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

• gen/qpid/client/AsyncSession_0_10.h