Improve help
authorEduardo Ramos Testillano <eduardo.ramos.testillano@ericsson.com>
Sun, 16 Jul 2017 12:19:19 +0000 (14:19 +0200)
committerEduardo Ramos Testillano <eduardo.ramos.testillano@ericsson.com>
Sun, 16 Jul 2017 12:19:19 +0000 (14:19 +0200)
include/anna/diameter.comm/Engine.hpp

index bcb91ce..6a7d133 100644 (file)
@@ -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.
    */