Improve help

[anna.git] / include / anna / diameter.comm / Engine.hpp

diff --git a/include/anna/diameter.comm/Engine.hpp b/include/anna/diameter.comm/Engine.hpp
index 72e3ad9..6a7d133 100644 (file)
--- a/include/anna/diameter.comm/Engine.hpp
+++ b/include/anna/diameter.comm/Engine.hpp
@@ -133,9 +133,11 @@ public:
 
   /**
    * Propagate auto recovery configuration to entities within engine. Recovery period is configured at
-   * #anna::comm::Communicator::setRecoveryTime. All the client client-sessions created throught #createEntity,
-   * will be created based on the engine auto-recovery value (enable by default). But you could access entities,
-   * servers or client-sessions independently to change this behaviour.
+   * #anna::comm::Communicator::setRecoveryTime (5 seconds by default). All the client client-sessions
+   * created throught #createEntity, will be created based on the engine auto-recovery value (enabled
+   * by default).
+   * You could access entities, servers or client-sessions independently to use this method, but recovery
+   * time should be updated through communicator and will apply for new created connections.
    *
    * @param autoRecovery Auto recovery indicator. True by default.
    */
@@ -771,7 +773,6 @@ private:
   // CLIENT FUNCTIONALITY //
   //////////////////////////
 
-  //typedef int clientSession_key; // exclusiveHash('ADDR:PORT|id')
   typedef std::string clientSession_key; // 'ADDR:PORT|id'
   typedef std::map <clientSession_key, ClientSession*> clientSession_container;
   typedef clientSession_container::value_type clientSession_value_type;
@@ -803,7 +804,6 @@ private:
   const_server_iterator server_end() const throw() { return a_servers.end(); }
   static const Server* server(const_server_iterator ii) throw() { return ii->second; }
 
-  //typedef int entity_key; // exclusiveHash('IP1:PORT1 IP2:PORT2 IP3:PORT3 ...')
   typedef std::string entity_key; // 'ADDR1:PORT1 ADDR2:PORT2 ADDR3:PORT3 ...'
   entity_key getEntityKey(const socket_v &) const throw();
   entity_key getEntityKey(const std::string & addr1, int port1, const std::string & addr2, int port2) const throw();