[sr-dev] git:master: outbound(k) Minor edit of documentation.

Module: sip-router Branch: master Commit: 66560d5ad5c136aa833db57ed32283d788f56611 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=66560d5… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Wed Jan 9 20:18:42 2013 +0100 outbound(k) Minor edit of documentation. Please ignore, keep calm and carry on. --- modules_k/outbound/README | 14 +++++++++----- modules_k/outbound/doc/outbound_admin.xml | 4 ++++ 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/modules_k/outbound/README b/modules_k/outbound/README index af8fb1f..0a71243 100644 --- a/modules_k/outbound/README +++ b/modules_k/outbound/README @@ -4,7 +4,7 @@ Peter Dunkley Crocodile RCS Ltd - Copyright © 2012 Crocodile RCS Ltd + Copyright � 2012 Crocodile RCS Ltd __________________________________________________________________ Table of Contents @@ -87,9 +87,9 @@ make all responses to REGISTERs. When using TCP or TLS as the SIP transport care should be taken to set - the “tcp_connection_lifetime” on the Edge Proxy to a value slightly + the "tcp_connection_lifetime" on the Edge Proxy to a value slightly larger than the interval the Registrar is using for flow timer. Setting - “tcp_connection_lifetime” to less than the interval could cause + "tcp_connection_lifetime" to less than the interval could cause connections to be lost, and setting it to a value much larger than the interval will keep connections open far longer than is required (which is wasteful). @@ -97,9 +97,9 @@ make all Application-layer keep-alives are optional when the underlying transport already has a keep-alive mechanism. The WebSocket transport has a transport-layer keep-alive. When using the WebSocket transport - the “keepalive_timeout” should be set to a value a little greater than + the "keepalive_timeout" should be set to a value a little greater than the Registrar flow timer interval and a little less than the - “tcp_connection_lifetime”. + "tcp_connection_lifetime". Example 1.2. Edge Proxy Configuration ... @@ -295,7 +295,9 @@ failure_route[FAIL_OUTBOUND] { Default value is -1. Example 1.4. Set force_outbound_flag parameter +... modparam("outbound", "force_outbound_flag", 1) +... 3.2. flow_token_key (string) @@ -310,7 +312,9 @@ Note Default value is: "". Example 1.5. Set flow_token_key parameter +... modparam("outbound", "flow_token_key", "!!!Kamailio rocks!!!") +... 4. Functions diff --git a/modules_k/outbound/doc/outbound_admin.xml b/modules_k/outbound/doc/outbound_admin.xml index 28c91d0..0dcd29a 100644 --- a/modules_k/outbound/doc/outbound_admin.xml +++ b/modules_k/outbound/doc/outbound_admin.xml @@ -268,7 +268,9 @@ failure_route[FAIL_OUTBOUND] { <title>Set <varname>force_outbound_flag</varname> parameter </title> <programlisting format="linespecific"> +... modparam("outbound", "force_outbound_flag", 1) +... </programlisting> </example> </section> @@ -285,7 +287,9 @@ modparam("outbound", "force_outbound_flag", 1) <title>Set <varname>flow_token_key</varname> parameter </title> <programlisting format="linespecific"> +... modparam("outbound", "flow_token_key", "!!!Kamailio rocks!!!") +... </programlisting> </example> </section>