[sr-dev] git:5.2:82d9703e: modules: readme files regenerated - modules ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: 5.2
Commit: 82d9703e619f765efcda8f37e45bfcfe4b22607e
URL: https://github.com/kamailio/kamailio/commit/82d9703e619f765efcda8f37e45bfcfe4b22607e

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2019-01-14T12:46:35+01:00

modules: readme files regenerated - modules ... [skip ci]

---

Modified: src/modules/dialog/README
Modified: src/modules/dispatcher/README

---

Diff:  https://github.com/kamailio/kamailio/commit/82d9703e619f765efcda8f37e45bfcfe4b22607e.diff
Patch: https://github.com/kamailio/kamailio/commit/82d9703e619f765efcda8f37e45bfcfe4b22607e.patch

---

diff --git a/src/modules/dialog/README b/src/modules/dialog/README
index b1b63b8e30..05a1b531f8 100644
--- a/src/modules/dialog/README
+++ b/src/modules/dialog/README
@@ -426,9 +426,10 @@ Chapter 1. Admin Guide
 
 2. How it works
 
-   To create the dialog associated with an initial request, the flag
-   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) must be set before
-   creating the corresponding transaction.
+   To create the dialog associated with an initial INVITE request, execute
+   the function “dlg_manage()” or set the flag specified by parameter
+   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) before creating the
+   corresponding transaction.
 
    The dialog is automatically destroyed when a “BYE” is received. In case
    of no “BYE”, the dialog lifetime is controlled via the default timeout
@@ -611,6 +612,10 @@ modparam("dialog", "rr_param", "xyz")
    Flag to be used for marking if a dialog should be constructed for the
    current request (this make sense only for initial requests).
 
+   Note: it is not needed to set this parameter and its corresponding flag
+   for initial request in case the “dlg_manage()” function is used. In
+   other words, using “dlg_manage()” alone is enough.
+
    Default value is “none”.
 
    Example 1.4. Set dlg_flag parameter
diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README
index 53a464d8ff..c788e393c8 100644
--- a/src/modules/dispatcher/README
+++ b/src/modules/dispatcher/README
@@ -697,10 +697,15 @@ Note
    Controls what gateways are tested to see if they are reachable.
      * Value 0: If set to 0, only the gateways with state PROBING are
        tested. After a gateway is probed, the PROBING state is cleared in
-       this mode.
+       this mode. This means that no probing will be executed at all only
+       if flag in config file is set to 8/PROBING (please check
+       destination list file syntaxis for more details), it will probe
+       only one time at startup or after dispatcher reload.
      * Value 1: If set to 1, all gateways are tested. If set to 1 and
        there is a failure of keepalive to an active gateway, then it is
-       set to TRYING state.
+       set to TRYING state. This means that probing will be executed all
+       the time, but you can skip some servers with flag 4 in destination
+       list file, for example.
      * Value 2: if set to 2, only gateways in inactive state with probing
        mode set are tested.
      * Value 3: If set to 3, any gateway with state PROBING is continually
@@ -1388,6 +1393,21 @@ kamcmd dispatcher.set_state ip 3 all
 
    Example:
                 kamcmd dispatcher.list
+ ...
+DEST: {
+        URI: sip:192.168.0.1:5060
+        FLAGS: AP
+        PRIORITY: 12
+}
+ ...
+
+   FLAGS consist out of 2 letters. First letter describe status of
+   destination: A-active, I – inactive, T – trying, D – disabled.
+   Second letter might be P or X. P is for probing, so AP means
+   destination is active and it is tested by SIP options continuously. X
+   means that there are no probing or sip pinging. So AX means that
+   destination is assumed as active and it is not tested by SIP options.
+   DX respectively is disabled destination that is not tested, etc.
 
 5.3.  dispatcher.reload