Browse code

dispatcher: docs - make a bullet list for the possible values for flags field

Daniel-Constantin Mierla authored on 28/11/2018 16:38:56
Showing 1 changed files
... ...
@@ -1776,12 +1776,23 @@ onreply_route {
1776 1776
 		</para>
1777 1777
 		<itemizedlist>
1778 1778
 			<listitem>
1779
-			<para>flags (listed by index - can be bitwise mask of values):
1780
-			0 (value 1) - inactive destination; 1 (value 2) - temporary trying
1781
-			destination (in the way to become inactive if it does not reply to
1782
-			keepalives - there is a module parameter to set the threshold of
1783
-			failures); 2 (value 4)  - admin disabled destination; 3 (value 8)
1784
-			- probing destination (sending keep alives);</para>
1779
+			<para>flags - control the mode of using the destination address and
1780
+			sending keepalives. It is a bitwise value that can be built using
1781
+			the folowing flags:
1782
+			<itemizedlist>
1783
+				<listitem><para>1 (bit at index 0 - 1 &lt;&lt;0) - inactive destination<para>
1784
+				</listitem>
1785
+				<listitem><para>2 (bit at index 1 - 1 &lt;&lt;1) - temporary trying
1786
+				destination (in the way to become inactive if it does not reply to
1787
+				keepalives - there is a module parameter to set the threshold of
1788
+				failures)<para>
1789
+				</listitem>
1790
+				<listitem><para>4 (bit at index 2 - 1 &lt;&lt;2) - admin disabled destination<para>
1791
+				</listitem>
1792
+				<listitem><para>8 (bit at index 3 - 1 &lt;&lt;3) - probing destination (sending keep alives);</para>
1793
+				</listitem>
1794
+			</itemizedlist>
1795
+			</para>
1785 1796
 			</listitem>
1786 1797
 			<listitem>
1787 1798
 			<para>priority: sets the priority in destination list (based on it