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

qpid::client::SubscriptionSettings Struct Reference

Settings for a subscription. More...

#include <qpid/client/SubscriptionSettings.h>

List of all members.

Public Member Functions

 SubscriptionSettings (FlowControl flow=FlowControl::unlimited(), AcceptMode accept=ACCEPT_MODE_EXPLICIT, AcquireMode acquire=ACQUIRE_MODE_PRE_ACQUIRED, unsigned int autoAck_=1, CompletionMode completion=COMPLETE_ON_DELIVERY)

Public Attributes

FlowControl flowControl
AcceptMode acceptMode
 < Flow control settings.
AcquireMode acquireMode
 < ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE
unsigned int autoAck
 < ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED
CompletionMode completionMode
 In windowing mode, completion of a message will cause the credit used up by that message to be reallocated.
bool exclusive
 If set, requests that no other subscriber be allowed to access the queue while this subscription is active.

Detailed Description

Settings for a subscription.

Definition at line 41 of file SubscriptionSettings.h.


Constructor & Destructor Documentation

qpid::client::SubscriptionSettings::SubscriptionSettings ( FlowControl  flow = FlowControl::unlimited(),
AcceptMode  accept = ACCEPT_MODE_EXPLICIT,
AcquireMode  acquire = ACQUIRE_MODE_PRE_ACQUIRED,
unsigned int  autoAck_ = 1,
CompletionMode  completion = COMPLETE_ON_DELIVERY 
) [inline]

Definition at line 43 of file SubscriptionSettings.h.


Member Data Documentation

< Flow control settings.

See also:
FlowControl

Definition at line 52 of file SubscriptionSettings.h.

< ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE

Definition at line 53 of file SubscriptionSettings.h.

< ACQUIRE_MODE_PRE_ACQUIRED or ACQUIRE_MODE_NOT_ACQUIRED

Automatically acknowledge (accept) batches of autoAck messages. 0 means no automatic acknowledgement. This has no effect for messsages received for a subscription with ACCEPT_MODE_NODE.

Definition at line 59 of file SubscriptionSettings.h.

In windowing mode, completion of a message will cause the credit used up by that message to be reallocated.

The subscriptions completion mode controls how completion is managed.

If set to COMPLETE_ON_DELIVERY (which is the default), messages will be marked as completed once they have been received. The server will be explicitly notified of all completed messages for the session when the next accept is sent through the subscription (either explictly or through autAck). However the server may also periodically request information on the completed messages.

If set to COMPLETE_ON_ACCEPT, messages will be marked as completed once they are accepted (via the Subscription class) and the server will also be notified of all completed messages for the session.

If set to MANUAL_COMPLETION the application is responsible for completing messages (

See also:
Session::markCompleted()).

Definition at line 82 of file SubscriptionSettings.h.

If set, requests that no other subscriber be allowed to access the queue while this subscription is active.

Definition at line 87 of file SubscriptionSettings.h.

Definition at line 51 of file SubscriptionSettings.h.


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

Qpid C++ API Reference
Generated on Thu Mar 4 00:51:08 2010 for Qpid C++ Client API by doxygen 1.6.1