QPID-2382: Created separate utility class for handling updates from failover exchange; cleaned up reconnection options

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@921971 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 15 insertions, 12 deletions

diff --git a/cpp/include/qpid/messaging/Connection.h b/cpp/include/qpid/messaging/Connection.h
index 36392da0b2..e2d1cc2ed4 100644
--- a/cpp/include/qpid/messaging/Connection.h
+++ b/cpp/include/qpid/messaging/Connection.h
@@ -58,29 +58,32 @@ class Connection : public qpid::client::Handle<ConnectionImpl>
      *     sasl-mechanism
      *     sasl-min-ssf
      *     sasl-max-ssf
+     *     protocol
+     *     urls
      * 
-     * (note also bounds, locale, max-channels and max-framesize, but not sure whether those should be docuemented here)
+     * (note also bounds, locale, max-channels and max-framesize, but
+     * not sure whether those should be documented here)
      * 
-     * Retry behaviour can be controlled through the following options:
-     *
-     *     reconnection-timeout - determines how long it will try to
-     *                            reconnect for -1 means forever, 0
-     *                            means don't try to reconnect
-     *     min-retry-interval
-     *     max-retry-interval
+     * Reconnect behaviour can be controlled through the following options:
      * 
-     *     The retry-interval is the time that the client waits for
-     *     after a failed attempt to reconnect before retrying. It
+     *     reconnect: true/false (enables/disables reconnect entirely)
+     *     reconnect-timeout: number of seconds (give up and report failure after specified time)
+     *     reconnect-limit: n (give up and report failure after specified number of attempts)
+     *     reconnect-interval-min: number of seconds (initial delay between failed reconnection attempts)
+     *     reconnect-interval-max: number of seconds (maximum delay between failed reconnection attempts)
+     *     reconnect-interval: shorthand for setting the same reconnect_interval_min/max
+     *
+     *     The reconnect-interval is the time that the client waits
+     *     for after a failed attempt to reconnect before retrying. It
      *     starts at the value of the min-retry-interval and is
      *     doubled every failure until the value of max-retry-interval
      *     is reached.
-     * 
-     *
      */
     QPID_CLIENT_EXTERN Connection(const Variant::Map& options = Variant::Map());
     QPID_CLIENT_EXTERN Connection(const std::string& options);
     QPID_CLIENT_EXTERN ~Connection();
     QPID_CLIENT_EXTERN Connection& operator=(const Connection&);
+    QPID_CLIENT_EXTERN void setOption(const std::string& name, const Variant& value);
     QPID_CLIENT_EXTERN void open(const std::string& url);
     QPID_CLIENT_EXTERN void close();
     QPID_CLIENT_EXTERN Session newSession(bool transactional, const std::string& name = std::string());