[sr-dev] git:pd/outbound: modules/registrar: Updated documentation for outbound related modparams

Module: sip-router Branch: pd/outbound Commit: 6b4d87a4321f8edefbf93b1323502d4bab965290 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=6b4d87a… Author: Peter Dunkley &lt;peter.dunkley(a)crocodile-rcs.com&gt; Committer: Peter Dunkley &lt;peter.dunkley(a)crocodile-rcs.com&gt; Date: Thu Mar 14 14:19:31 2013 +0000 modules/registrar: Updated documentation for outbound related modparams --- modules/registrar/README | 39 +++++++++++----------- modules/registrar/doc/registrar_admin.xml | 51 +++++++++++++--------------- 2 files changed, 43 insertions(+), 47 deletions(-) diff --git a/modules/registrar/README b/modules/registrar/README index f89b36d..afc7160 100644 --- a/modules/registrar/README +++ b/modules/registrar/README @@ -642,24 +642,23 @@ modparam("registrar", "gruu_enabled", 0) 3.24. outbound_mode (integer) - If set to 0 then this module will accept REGISTER requests that do not + If set to 0 this module will accept REGISTER requests that do not contain a Supported: header with the outbound options-tag. The 200 OK response to REGISTER requests that this module generates will not - contain Require: or Supported: headers with the outbound options tag. + contain Require: or Supported: headers with the outbound options-tag. + If the client has a Require: header with the outbound options tag the + REGISTER will be rejected with a 420 Bad Extension response. - If set to 1 then this module will accept REGISTER requests that do not - contain a Supported: header with the outbound options-tag. The 200 OK - response to REGISTER requests that this module generates will contain a - Supported: header with the outbound options tag. - - If set to 2 then this module will reject REGISTER requests that do not - contain a Supported: header with the outbound options-tag. The 200 OK - response to REGISTER requests that this module generates will contain - Require: and Supported: headers with the outbound options tag. + If set to 1 this module will accept REGISTER requests that do not + contain a Supported: header with the outbound options-tag and REGISTER + requests that do contain a Supported: or Requires: header with the + outbound options-tag. When the client supports outbound the appropriate + RFC5626 procedures will be followed. - Set this parameter to 2 if you are using SIP Outbound (RFC 5626) and - want your Edge Proxy to insert a Flow-Timer: header into the 200 OK - response to REGISTERs (as per RFC 5626 section 5.4). + If set to 2 this module will reject REGISTER requests that do not + contain a Supported: header with the outbound options-tag. When the + client supports outbound the appropriate RFC5626 procedures will be + followed. Default value is 0. @@ -675,17 +674,17 @@ modparam("registrar", "outbound_mode", 2) If set to > 0 then this module will add a Flow-Timer: header containing this value to 200 OK responses to REGISTER requests. This parameter may - only be set to a value > 0 when outbound_mode is set to 2. + only be set to a value > 0 when outbound_mode is set to 1 or 2. When set to a value > 0 this parameter should be set to slightly less than the connection timeout value between the UAC and the network (this corresponds to the core tcp_connection_lifetime option and websocket keepalive_timeout modparam). This parameter is most useful when you - have a single edge proxy/registrar. If you are using a separate SIP - Outbound Edge Proxy you should consider leaving this parameter set to 0 - and adding the Flow-Timer: header on the Edge Proxy (as this allows you - to keep all of the timer values for a specific flow in one - configuration - that of the Edge Proxy). + have a single edge proxy/registrar or if you have an edge proxy that + cannot modify responses. If you are using a separate edge proxy you + should consider leaving this parameter set to 0 and adding the + Flow-Timer: header on the edge proxy as this allows you to keep all of + the timer values for a specific flow in one configuration. Default value is 0. diff --git a/modules/registrar/doc/registrar_admin.xml b/modules/registrar/doc/registrar_admin.xml index ef8e78b..8b0609d 100644 --- a/modules/registrar/doc/registrar_admin.xml +++ b/modules/registrar/doc/registrar_admin.xml @@ -724,31 +724,27 @@ modparam("registrar", "gruu_enabled", 0) <section> <title><varname>outbound_mode</varname> (integer)</title> <para> - If set to 0 then this module will accept REGISTER requests - that do not contain a Supported: header with the outbound - options-tag. The 200 OK response to REGISTER requests that this - module generates will not contain Require: or Supported: headers - with the outbound options tag. + If set to 0 this module will accept REGISTER requests that do + not contain a Supported: header with the outbound options-tag. + The 200 OK response to REGISTER requests that this module + generates will not contain Require: or Supported: headers with + the outbound options-tag. If the client has a Require: header + with the outbound options tag the REGISTER will be rejected + with a 420 Bad Extension response. </para> <para> - If set to 1 then this module will accept REGISTER requests - that do not contain a Supported: header with the outbound - options-tag. The 200 OK response to REGISTER requests that this - module generates will contain a Supported: header with the - outbound options tag. + If set to 1 this module will accept REGISTER requests that + do not contain a Supported: header with the outbound + options-tag and REGISTER requests that do contain a Supported: + or Requires: header with the outbound options-tag. When the + client supports outbound the appropriate RFC5626 procedures + will be followed. </para> <para> - If set to 2 then this module will reject REGISTER requests - that do not contain a Supported: header with the outbound - options-tag. The 200 OK response to REGISTER requests that this - module generates will contain Require: and Supported: headers - with the outbound options tag. - </para> - <para> - Set this parameter to 2 if you are using SIP Outbound (RFC - 5626) and want your Edge Proxy to insert a Flow-Timer: header - into the 200 OK response to REGISTERs (as per RFC 5626 section - 5.4). + If set to 2 this module will reject REGISTER requests that + do not contain a Supported: header with the outbound + options-tag. When the client supports outbound the appropriate + RFC5626 procedures will be followed. </para> <para> <emphasis> @@ -775,7 +771,7 @@ modparam("registrar", "outbound_mode", 2) If set to > 0 then this module will add a Flow-Timer: header containing this value to 200 OK responses to REGISTER requests. This parameter may only be set to a value > 0 when - <emphasis>outbound_mode</emphasis> is set to 2. + <emphasis>outbound_mode</emphasis> is set to 1 or 2. </para> <para> When set to a value > 0 this parameter should be set to slightly @@ -783,13 +779,14 @@ modparam("registrar", "outbound_mode", 2) network (this corresponds to the core <emphasis>tcp_connection_lifetime</emphasis> option and <emphasis>websocket</emphasis> - <emphasis>keepalive_timeout</emphasis> modparam). This parameter - is most useful when you have a single edge proxy/registrar. If - you are using a separate SIP Outbound Edge Proxy you should + <emphasis>keepalive_timeout</emphasis> modparam). This + parameter is most useful when you have a single edge + proxy/registrar or if you have an edge proxy that cannot modify + responses. If you are using a separate edge proxy you should consider leaving this parameter set to 0 and adding the - Flow-Timer: header on the Edge Proxy (as this allows you to + Flow-Timer: header on the edge proxy as this allows you to keep all of the timer values for a specific flow in one - configuration - that of the Edge Proxy). + configuration. </para> <para> <emphasis>