[sr-dev] git:master: dispatcher(k): updated description of flags field

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 8b180f5834081a5500cac6938452c29d60d9f41a
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8b180f5834081a5500cac6938452c29d60d9f41a

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Thu Feb  9 15:42:00 2012 +0100

dispatcher(k): updated description of flags field

---

 modules_k/dispatcher/README                   |    8 ++++++--
 modules_k/dispatcher/doc/dispatcher_admin.xml |    8 ++++++--
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/modules_k/dispatcher/README b/modules_k/dispatcher/README
index e1cfd68..cffcc6d 100644
--- a/modules_k/dispatcher/README
+++ b/modules_k/dispatcher/README
@@ -988,8 +988,12 @@ sercmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
    SIP URI format).
 
    Optionally, these fields can be followed by:
-     * flags: 1 - destination inactive, 2 - destination in probing mode --
-       you can do bitwise OR to set both flags
+     * flags (listed by index - can be bitwise mask of values): 0 (value
+       1) - inactive destination; 1 (value 2) - temporary trying
+       destination (in the way to become inactive if it does not reply to
+       keepalives - there is a module parameter to set the threshold of
+       failures); 2 (value 4) - admin disabled destination; 3 (value 8) -
+       probing destination (sending keep alives);
      * priority: sets the priority in destination list (based on it is
        done the initial ordering inside the set)
      * attributes: extra filed in form of name1=value1;...;nameN=valueN.
diff --git a/modules_k/dispatcher/doc/dispatcher_admin.xml b/modules_k/dispatcher/doc/dispatcher_admin.xml
index ce0cb93..83f6c70 100644
--- a/modules_k/dispatcher/doc/dispatcher_admin.xml
+++ b/modules_k/dispatcher/doc/dispatcher_admin.xml
@@ -1227,8 +1227,12 @@ sercmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
 		</para>
 		<itemizedlist>
 			<listitem>
-			<para>flags: 1 - destination inactive, 2 - destination in probing
-			mode -- you can do bitwise OR to set both flags</para>
+			<para>flags (listed by index - can be bitwise mask of values):
+			0 (value 1) - inactive destination; 1 (value 2) - temporary trying
+			destination (in the way to become inactive if it does not reply to
+			keepalives - there is a module parameter to set the threshold of
+			failures); 2 (value 4)  - admin disabled destination; 3 (value 8)
+			- probing destination (sending keep alives);</para>
 			</listitem>
 			<listitem>
 			<para>priority: sets the priority in destination list (based on it