소스 검색

modules/registrar: Updated documentation for outbound related modparams

Peter Dunkley 12 년 전
부모
커밋
6b4d87a432
2개의 변경된 파일43개의 추가작업 그리고 47개의 파일을 삭제
  1. 19 20
      modules/registrar/README
  2. 24 27
      modules/registrar/doc/registrar_admin.xml

+ 19 - 20
modules/registrar/README

@@ -642,24 +642,23 @@ modparam("registrar", "gruu_enabled", 0)
 
 
 3.24. outbound_mode (integer)
 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
    contain a Supported: header with the outbound options-tag. The 200 OK
    response to REGISTER requests that this module generates will not
    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.
    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
    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
    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
    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
    than the connection timeout value between the UAC and the network (this
    corresponds to the core tcp_connection_lifetime option and websocket
    corresponds to the core tcp_connection_lifetime option and websocket
    keepalive_timeout modparam). This parameter is most useful when you
    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.
    Default value is 0.
 
 

+ 24 - 27
modules/registrar/doc/registrar_admin.xml

@@ -724,31 +724,27 @@ modparam("registrar", "gruu_enabled", 0)
 	<section>
 	<section>
 		<title><varname>outbound_mode</varname> (integer)</title>
 		<title><varname>outbound_mode</varname> (integer)</title>
 		<para>
 		<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>
 		<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>
 		<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>
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>
@@ -775,7 +771,7 @@ modparam("registrar", "outbound_mode", 2)
 		If set to > 0 then this module will add a Flow-Timer: header
 		If set to > 0 then this module will add a Flow-Timer: header
 		containing this value to 200 OK responses to REGISTER requests.
 		containing this value to 200 OK responses to REGISTER requests.
 		This parameter may only be set to a value > 0 when
 		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>
 		<para>
 		<para>
 		When set to a value > 0 this parameter should be set to slightly
 		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
 		network (this corresponds to the core
 		<emphasis>tcp_connection_lifetime</emphasis> option and
 		<emphasis>tcp_connection_lifetime</emphasis> option and
 		<emphasis>websocket</emphasis>
 		<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
 		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
 		keep all of the timer values for a specific flow in one
-		configuration - that of the Edge Proxy).
+		configuration.
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>