[sr-dev] git:master: dispatcher(k): updated description and dependencies

Module: sip-router Branch: master Commit: 51ec1f966ed2932daefffb52fe0ae432cf2de3c7 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=51ec1f9… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Mon Oct 4 13:41:10 2010 +0200 dispatcher(k): updated description and dependencies --- modules_k/dispatcher/README | 19 ++++++++++++---- modules_k/dispatcher/doc/dispatcher_admin.xml | 29 +++++++++++++++++++------ 2 files changed, 36 insertions(+), 12 deletions(-) diff --git a/modules_k/dispatcher/README b/modules_k/dispatcher/README index bcf71b7..67177a5 100644 --- a/modules_k/dispatcher/README +++ b/modules_k/dispatcher/README @@ -190,12 +190,19 @@ Chapter 1. Admin Guide 1. Overview - This modules implements a dispatcher for destination addresses. It - computes hashes over parts of the request and selects an address from a - destination set. The selected address is used then as outbound proxy. + This module offers SIP load balancer functionality and it can be used + as SIP traffic dispatcher. There are many load balancing and traffic + dispaching algorithms that you can choose from, like: round-robin, + weight based load balancing, call load distribution, hashing over SIP + message attributes. - The module can be used as a stateless load balancer, having no - guarantee of fair distribution. + The module can be used as a stateless load balancer, it does not depend + on any call state tracing module. It requires TM module if you enable + auto-discovery of active/inactive gateways. + + It is very lightweight, therefore suitable for handling heavy SIP + traffic. Its small footprint and ability to load balancing rules from a + text plain file makes it suitable for embedded systems. 2. Dependencies @@ -206,6 +213,8 @@ Chapter 1. Admin Guide The following modules must be loaded before this module: * TM - only if active recovery of failed hosts is required. + * database engine - only if you want to load balancing routes from + database instead of plain text file. . 2.2. External libraries or applications diff --git a/modules_k/dispatcher/doc/dispatcher_admin.xml b/modules_k/dispatcher/doc/dispatcher_admin.xml index f0d694c..a6c8748 100644 --- a/modules_k/dispatcher/doc/dispatcher_admin.xml +++ b/modules_k/dispatcher/doc/dispatcher_admin.xml @@ -16,14 +16,21 @@ <section> <title>Overview</title> <para> - This modules implements a dispatcher for destination addresses. It - computes hashes over parts of the request and selects an address from - a destination set. The selected address is used then as outbound - proxy. + This module offers SIP load balancer functionality and it can be + used as SIP traffic dispatcher. There are many load balancing and + traffic dispaching algorithms that you can choose from, like: + round-robin, weight based load balancing, call load distribution, + hashing over SIP message attributes. </para> <para> - The module can be used as a stateless load balancer, having no - guarantee of fair distribution. + The module can be used as a stateless load balancer, it does not + depend on any call state tracing module. It requires TM module if + you enable auto-discovery of active/inactive gateways. + </para> + <para> + It is very lightweight, therefore suitable for handling heavy SIP + traffic. Its small footprint and ability to load balancing rules + from a text plain file makes it suitable for embedded systems. </para> </section> <section> @@ -35,7 +42,15 @@ <itemizedlist> <listitem> <para> - <emphasis>TM - only if active recovery of failed hosts is required</emphasis>. + <emphasis>TM - only if active recovery of failed hosts + is required</emphasis>. + </para> + </listitem> + <listitem> + <para> + <emphasis>database engine - only if you want to load + balancing routes from database instead of plain text file. + </emphasis>. </para> </listitem> </itemizedlist>