Author: gsim
Date: Fri Dec 11 18:00:39 2009
New Revision: 889736
URL: http://svn.apache.org/viewvc?rev=889736&view=rev
Log:
QPID-2087: Some amplification of doxygen for SubscriptionSettings
Modified:
qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionSettings.h
Modified: qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionSettings.h
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionSettings.h?rev=889736&r1=889735&r2=889736&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionSettings.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionSettings.h Fri Dec 11
18:00:39 2009
@@ -49,13 +49,44 @@
) : flowControl(flow), acceptMode(accept), acquireMode(acquire),
autoAck(autoAck_), completionMode(completion), exclusive(false) {}
FlowControl flowControl; ///@< Flow control settings. @see FlowControl
+ /**
+ * The acceptMode determines whether the broker should expect
+ * delivery of messages to be acknowledged by the client
+ * indicating that it accepts them. A value of
+ * ACCEPT_MODE_EXPLICIT means that messages must be accepted
+ * (note: this may be done automatically by the library - see
+ * autoAck - or through an explicit call be the application - see
+ * Subscription::accept()) before they can be dequeued. A value of
+ * ACCEPT_MODE_NONE means that the broker can dequeue a message as
+ * soon as it is acquired.
+ */
AcceptMode acceptMode; ///@< ACCEPT_MODE_EXPLICIT or ACCEPT_MODE_NONE
+ /**
+ * The acquireMode determines whether messages are locked for the
+ * subscriber when delivered, and thus are not delivered to any
+ * other subscriber unless this subscriber releases them.
+ *
+ * The default is ACQUIRE_MODE_PRE_ACQUIRED meaning that the
+ * subscriber expects to have been given that message exclusively
+ * (i.e. the message will not be given to any other subscriber
+ * unless released explicitly or by this subscribers session
+ * failing without having accepted the message).
+ *
+ * Delivery of message in ACQUIRE_MODE_NOT_ACQUIRED mode means the
+ * message will still be available for other subscribers to
+ * receive. The application can if desired acquire a (set of)
+ * messages through an explicit acquire call - see
+ * Subscription::acquire().
+ */
AcquireMode acquireMode; ///@< 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.*/
+ /**
+ * Configures the frequency at which messages are automatically
+ * accepted (e.g. a value of 5 means that messages are accepted in
+ * batches of 5). A value of 0 means no automatic acknowledgement
+ * will occur and the application will itself be responsible for
+ * accepting messages.
+ */
unsigned int autoAck;
/**
* In windowing mode, completion of a message will cause the
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
