Browse Source

dispatcher(k): updated description of flags field

Daniel-Constantin Mierla 13 years ago
parent
commit
8b180f5834
2 changed files with 12 additions and 4 deletions
  1. 6 2
      modules_k/dispatcher/README
  2. 6 2
      modules_k/dispatcher/doc/dispatcher_admin.xml

+ 6 - 2
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.

+ 6 - 2
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