svn commit: r712173 - /incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h

[gs...@apache.org]

Author: gsim
Date: Fri Nov  7 07:52:46 2008
New Revision: 712173

URL: http://svn.apache.org/viewvc?rev=712173&view=rev
Log:
Added a bit more detail to comments.


Modified:
    incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h

Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h
URL: http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h?rev=712173&r1=712172&r2=712173&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/FailoverManager.h Fri Nov  7 07:52:46 2008
@@ -91,6 +91,9 @@
      * known brokers from the last connection will be used. If no list
      * is specified and this is the first connect attempt, the host
      * and port from the initial settings will be used.
+     * 
+     * If the full list is tried and all attempts fail,
+     * CannotConnectException is thrown.
      */
     Connection& connect(std::vector<Url> brokers = std::vector<Url>());
     /**
@@ -106,6 +109,12 @@
      * a session on which to carry out the work of the command,
      * handling failover occuring while exeuting that command and
      * re-starting the work.
+     * 
+     * Multiple concurrent threads can call execute with different
+     * commands; each thread will be allocated its own
+     * session. FailoverManager will coordinate the different threads
+     * on failover to ensure they continue to use the same logical
+     * connection.
      */
     void execute(Command&);
   private: