[sr-dev] git:master: dispatcher: dedicated section for attributes in docs

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Sun Dec 14 14:21:06 2014 +0100

dispatcher: dedicated section for attributes in docs

- file format has it own section too

---

 modules/dispatcher/doc/dispatcher_admin.xml |   49 ++++++++++++++++++++------
 1 files changed, 37 insertions(+), 12 deletions(-)

diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
index 43deb72..404bbd2 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -1394,21 +1394,45 @@ onreply_route {
 			</listitem>
 			<listitem>
 			<para>attributes: extra fields in form of
-				name1=value1;...;nameN=valueN. There are some predefined names:
-				<itemizedlist>
-					<listitem>
-						'duid' - used for call load dispatching
-					</listitem>
-					<listitem>
-						'weight' - used for weight based load distribution
-					</listitem>
-					<listitem>
-						'socket' - used to set the sending socket for the gateway
-					</listitem>
-				</itemizedlist>
+				name1=value1;...;nameN=valueN.
 			</para>
 			</listitem>
 		</itemizedlist>
+		<section id="dispatcher.ex.attributes">
+			<title>Special Attributes</title>
+			<para>
+			There are some predefined names:
+			<itemizedlist>
+				<listitem>
+					'duid' - used for call load dispatching. It must be an
+					unique value to identify a destination (gateway address).
+					Practically the load within the group is associated with
+					this value.
+				</listitem>
+				<listitem>
+					'maxload' - used for call load dispatching. It must be
+					a positive integer, defining the upper limit of active
+					calls per destination. When the limit is reached, then
+					the gateway is no longer selected for new calls until
+					an exiting call via that gateway is terminated. If set
+					to 0, then no active call limit is used.
+				</listitem>
+				<listitem>
+					'weight' - used for weight based load distribution. It
+					must be set to a positive integer value beteen 0 and
+					100. The value represents the percent of calls to be
+					sent to that gateways.
+				</listitem>
+				<listitem>
+					'socket' - used to set the sending socket for the gateway.
+					It is used for sending the SIP traffic as well as
+					OPTIONS keepalives.
+				</listitem>
+			</itemizedlist>
+		</para>
+		</section>
+		<section id="dispatcher.ex.fileforma">
+			<title>File Format</title>
 		<para>
 		Line format is:
 		</para>
@@ -1440,6 +1464,7 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt)
 </programlisting>
 		</example>
 		</section>
+		</section>
 	
 		<section id="dispatcher.ex.config">
 		<title>&kamailio; config file</title>