[sr-dev] git:master: modules/ims_qos: updated doc for rx_forced_peer

Module: sip-router Branch: master Commit: b957dfd27e5350828f500520af33394806142296 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b957dfd… Author: Jason Penton &lt;jason.penton(a)gmail.com&gt; Committer: Jason Penton &lt;jason.penton(a)gmail.com&gt; Date: Tue Jun 3 09:42:18 2014 +0200 modules/ims_qos: updated doc for rx_forced_peer --- modules/ims_qos/doc/ims_qos_admin.xml | 119 ++++++++++++++++----------------- 1 files changed, 57 insertions(+), 62 deletions(-) diff --git a/modules/ims_qos/doc/ims_qos_admin.xml b/modules/ims_qos/doc/ims_qos_admin.xml index 913d558..43223c3 100644 --- a/modules/ims_qos/doc/ims_qos_admin.xml +++ b/modules/ims_qos/doc/ims_qos_admin.xml @@ -12,12 +12,11 @@ <section> <title>Overview</title> - <para>This module contains all method related to the IMS policy and - charging control functions performed by an Application Function (e.g. - P-CSCF) over the Rx interface. This module is dependent on the CDP (C - Diameter Peer) modules for communicating with PCRF as specified in 3GPP - specification TS 29.214. - </para> + <para>This module contains all method related to the IMS policy and + charging control functions performed by an Application Function (e.g. + P-CSCF) over the Rx interface. This module is dependent on the CDP (C + Diameter Peer) modules for communicating with PCRF as specified in 3GPP + specification TS 29.214.</para> </section> <section> @@ -32,11 +31,11 @@ <listitem> <para>Dialog2</para> </listitem> - + <listitem> <para>Usrloc PCSCF</para> </listitem> - + <listitem> <para>TM - Transaction Manager</para> </listitem> @@ -64,7 +63,7 @@ <section> <title><varname>rx_dest_realm</varname> (string)</title> - <para>This is the name of the Diameter realm of the Diameter server + <para>This is the name of the Diameter realm of the Diameter server (typically a PCRF).</para> <para><emphasis> Default value is 'ims.smilecoms.com'. @@ -80,15 +79,17 @@ modparam("ims_qos", "rx_dest_realm", "ims.smilecoms.com") </programlisting> </example> </section> - + <section> <title><varname>rx_forced_peer</varname> (string)</title> - <para>This is the optional name of the origin host of the Diameter server - (typically a PCRF). If not set then realm routing is used.</para> + <para>FQDN of the Diameter server (typically a PCRF) to communicate + with. If not set then realm routing is used. If you use this, the + routing defined in your diameter xml configuration file (CDP) will be + ignored and as a result you will lose the benefits of load balancing and + failover. </para> - <para><emphasis> Default value is ''. - </emphasis></para> + <para><emphasis> Default value is ''. </emphasis></para> <example> <title><varname>rx_forced_peer</varname> parameter usage</title> @@ -100,15 +101,14 @@ modparam("ims_qos", "rx_forced_peer", "pcrf.ims.smilecoms.com") </programlisting> </example> </section> - + <section> <title><varname>rx_auth_expiry</varname> (integer)</title> - <para>This is the expiry length in seconds of the initiated - Diameter sessions.</para> + <para>This is the expiry length in seconds of the initiated Diameter + sessions.</para> - <para><emphasis> Default value is 7200. - </emphasis></para> + <para><emphasis> Default value is 7200. </emphasis></para> <example> <title><varname>rx_auth_expiry</varname> parameter usage</title> @@ -120,15 +120,14 @@ modparam("ims_qos", "rx_auth_expiry", 14400) </programlisting> </example> </section> - + <section> <title><varname>cdp_event_latency</varname> (integer)</title> - <para>This is a flag to determine whether or slow CDP responses should be - reported in the log file. 1 is enabled and 0 is disabled.</para> + <para>This is a flag to determine whether or slow CDP responses should + be reported in the log file. 1 is enabled and 0 is disabled.</para> - <para><emphasis> Default value is 1. - </emphasis></para> + <para><emphasis> Default value is 1. </emphasis></para> <example> <title><varname>cdp_event_latency</varname> parameter usage</title> @@ -140,18 +139,16 @@ modparam("ims_qos", "cdp_event_latency", 1) </programlisting> </example> </section> - + <section> <title><varname>cdp_event_threshold</varname> (integer)</title> - <para>This time in milliseconds is the limit we should report a CDP - response as slow. i.e. if a CDP response exceeds this limit it will be - reported in the log file. This is only relevant is cdp_event_latency is - enabled (set to 0). - </para> + <para>This time in milliseconds is the limit we should report a CDP + response as slow. i.e. if a CDP response exceeds this limit it will be + reported in the log file. This is only relevant is cdp_event_latency is + enabled (set to 0).</para> - <para><emphasis> Default value is 500. - </emphasis></para> + <para><emphasis> Default value is 500. </emphasis></para> <example> <title><varname>cdp_event_threshold</varname> parameter usage</title> @@ -163,20 +160,19 @@ modparam("ims_qos", "cdp_event_threshold", 500) </programlisting> </example> </section> - + <section> <title><varname>cdp_event_latency_log</varname> (integer)</title> - <para>This time log level at which we should report slow CDP responses. - 0 is ERROR, 1 is WARN, 2 is INFO and 3 is DEBUG. This is only - relevant is cdp_event_latency is enabled (set to 0) - </para> + <para>This time log level at which we should report slow CDP responses. + 0 is ERROR, 1 is WARN, 2 is INFO and 3 is DEBUG. This is only relevant + is cdp_event_latency is enabled (set to 0)</para> - <para><emphasis> Default value is 0. - </emphasis></para> + <para><emphasis> Default value is 0. </emphasis></para> <example> - <title><varname>cdp_event_latency_log</varname> parameter usage</title> + <title><varname>cdp_event_latency_log</varname> parameter + usage</title> <programlisting format="linespecific"> ... @@ -185,21 +181,20 @@ modparam("ims_qos", "cdp_event_latency_log", 1) </programlisting> </example> </section> - </section> <section> <title>Functions</title> <section> - <title><function - moreinfo="none">Rx_AAR_Register(route_block, domain)</function></title> + <title><function moreinfo="none">Rx_AAR_Register(route_block, + domain)</function></title> - <para>Perform a AAR on Diameter RX interface to subscribe to signalling - status. This purpose of this is tell a Diameter server (typically a PCRF) - to inform the requesting Diameter client on changes to the status of - signalling bearer for the same framed IP address. For more details see - 3GGP TS 29.214. </para> + <para>Perform a AAR on Diameter RX interface to subscribe to signalling + status. This purpose of this is tell a Diameter server (typically a + PCRF) to inform the requesting Diameter client on changes to the status + of signalling bearer for the same framed IP address. For more details + see 3GGP TS 29.214.</para> <para>Meaning of the parameters is as follows:</para> @@ -207,8 +202,9 @@ modparam("ims_qos", "cdp_event_latency_log", 1) <listitem> <para>Route block to resume after async UAR Diameter reply.</para> </listitem> + <listitem> - <para><emphasis>domain</emphasis> that usrloc_pcscf uses to store + <para><emphasis>domain</emphasis> that usrloc_pcscf uses to store user information.</para> </listitem> </itemizedlist> @@ -242,28 +238,30 @@ route[REG_AAR_REPLY] </programlisting> </example> </section> - + <section> - <title><function - moreinfo="none">Rx_AAR(route_block, direction)</function></title> + <title><function moreinfo="none">Rx_AAR(route_block, + direction)</function></title> + + <para>Perform a AAR on Diameter RX interface to request resource + authorisation from a Diameter server (typically a PCRF). For more + details see 3GGP TS 29.214.</para> - <para>Perform a AAR on Diameter RX interface to request resource - authorisation from a Diameter server (typically a PCRF). For more details - see 3GGP TS 29.214. </para> - <para>Meaning of the parameters is as follows:</para> <itemizedlist> <listitem> <para>Route block to resume after async UAR Diameter reply.</para> </listitem> + <listitem> - <para><emphasis>direction</emphasis>the direction of this message - + <para><emphasis>direction</emphasis>the direction of this message - orig, term, etc.</para> </listitem> </itemizedlist> - <para>This function can be used from REQUEST_ROUTE or ONREPLY_ROUTE.</para> + <para>This function can be used from REQUEST_ROUTE or + ONREPLY_ROUTE.</para> <para>p.s. this is executed asynchronously. See example on how to retrieve return value</para> @@ -290,10 +288,7 @@ route[ORIGN_SESSION_AAR_REPLY] </programlisting> </example> </section> - - - - </section> + </section> <section> <title>Statistics</title>