From fcfff56e615c4054d52dc510c9cd1d1103249dce Mon Sep 17 00:00:00 2001
From: Gordon Sim <gsim@apache.org>
Date: Fri, 9 Apr 2010 16:27:35 +0000
Subject: QPID-664: changed pending to unsettled; added available to sender;
 minor update to address doc

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@932490 13f79535-47bb-0310-9956-ffa450edef68
---
 cpp/include/qpid/messaging/Address.h  | 9 ++++++++-
 cpp/include/qpid/messaging/Receiver.h | 2 +-
 cpp/include/qpid/messaging/Sender.h   | 8 ++++++--
 cpp/include/qpid/messaging/Session.h  | 8 +++++---
 4 files changed, 20 insertions(+), 7 deletions(-)

(limited to 'cpp/include')

diff --git a/cpp/include/qpid/messaging/Address.h b/cpp/include/qpid/messaging/Address.h
index 3722db94e8..99e41bb253 100644
--- a/cpp/include/qpid/messaging/Address.h
+++ b/cpp/include/qpid/messaging/Address.h
@@ -84,9 +84,16 @@ class AddressImpl;
  *
  * <tr valign=top>
  *   <td>node</td>
+
  *   <td>A nested map describing properties of the addressed
  *       node. Current properties supported are type (topic or queue),
- *       durable (boolean), x-declare and x-bindings.
+ *       durable (boolean), x-declare and x-bindings. The x-declare
+ *       option is a nested map in whcih protocol amqp 0-10 specific
+ *       options for queue or exchange declare can be specified. The
+ *       x-bindings option is a nested list, each element of which can
+ *       specify a queue, an exchange, a binding-key and arguments,
+ *       which are used to establish a binding on create. The node
+ *       will be used if queue or exchange values are not specified.
  *   </td>
  * </tr>
  *
diff --git a/cpp/include/qpid/messaging/Receiver.h b/cpp/include/qpid/messaging/Receiver.h
index 6926d3401a..738ff82507 100644
--- a/cpp/include/qpid/messaging/Receiver.h
+++ b/cpp/include/qpid/messaging/Receiver.h
@@ -104,7 +104,7 @@ class Receiver : public qpid::messaging::Handle<ReceiverImpl>
      * acknowledgement has not yet been confirmed as processed by the
      * server.
      */
-    QPID_CLIENT_EXTERN uint32_t getPendingAck();
+    QPID_CLIENT_EXTERN uint32_t getUnsettled();
 
     /**
      * Cancels this receiver.
diff --git a/cpp/include/qpid/messaging/Sender.h b/cpp/include/qpid/messaging/Sender.h
index 7c4b68731e..80fa174d80 100644
--- a/cpp/include/qpid/messaging/Sender.h
+++ b/cpp/include/qpid/messaging/Sender.h
@@ -70,8 +70,12 @@ class Sender : public qpid::messaging::Handle<SenderImpl>
      * Returns the number of sent messages pending confirmation of
      * receipt by the broker. (These are the 'in-doubt' messages).
      */
-    QPID_CLIENT_EXTERN uint32_t getPending();
-
+    QPID_CLIENT_EXTERN uint32_t getUnsettled();
+    /**
+     * Returns the number of messages for which there is available
+     * capacity.
+     */
+    QPID_CLIENT_EXTERN uint32_t getAvailable();
     /**
      * Returns the name of this sender.
      */
diff --git a/cpp/include/qpid/messaging/Session.h b/cpp/include/qpid/messaging/Session.h
index b3bc527329..ac0ea425f6 100644
--- a/cpp/include/qpid/messaging/Session.h
+++ b/cpp/include/qpid/messaging/Session.h
@@ -96,15 +96,17 @@ class Session : public qpid::messaging::Handle<SessionImpl>
 
     /**
      * Returns the total number of messages received and waiting to be
-     * fetched by all Receivers belonging to this session.
+     * fetched by all Receivers belonging to this session. This is the
+     * total number of available messages across all receivers on this
+     * session.
      */
-    QPID_CLIENT_EXTERN uint32_t getAvailable();
+    QPID_CLIENT_EXTERN uint32_t getReceivable();
     /**
      * Returns a count of the number of messages received this session
      * that have been acknowledged, but for which that acknowledgement
      * has not yet been confirmed as processed by the server.
      */
-    QPID_CLIENT_EXTERN uint32_t getPendingAck();
+    QPID_CLIENT_EXTERN uint32_t getUnsettledAcks();
     /**
      * Retrieves the receiver for the next available message. If there
      * are no available messages at present the call will block for up
-- 
cgit v1.2.1