Module: sip-router Branch: master Commit: 3627d33e720d51046a37b49e91d509370064015d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3627d33e...
Author: Olle E. Johansson oej@edvina.net Committer: Olle E. Johansson oej@edvina.net Date: Sun Oct 5 21:32:08 2014 +0200
QOS minor doc updates
---
modules/qos/README | 22 +++++++------- modules/qos/doc/qos_admin.xml | 63 ++++++++++++++++++++++------------------ 2 files changed, 46 insertions(+), 39 deletions(-)
diff --git a/modules/qos/README b/modules/qos/README index 120ca1b..563edd7 100644 --- a/modules/qos/README +++ b/modules/qos/README @@ -76,22 +76,22 @@ Chapter 1. Admin Guide entire life of a dialog.
All of this happens with a properly configured dialog and qos module - and setting the dialog flag and the qos flag at the time any INVITE sip + and setting the dialog flag and the qos flag at the time any INVITE SIP message is seen. There is no config script function call required to set the SDP session tracking mechanism. See the dialog module users guide for more information.
A dialog can have one or more SDP sessions active in one of the following states: - * pending - only one end point of the SDP session is known. - * negotiated - both end points of the SDP session are known. + * pending - only one endpoint of the SDP session is known. + * negotiated - both endpoints of the SDP session are known.
An SDP session can be established in one of the following scenarios: * INVITE/200ok - typical "INVITE" and "200 OK" SDP exchange. * 200ok/ACK - "200 OK" and "ACK" SDP exchange (for calls starting with an empty INVITE). * 183/PRACK - early media via "183 Session Progress" and "PRACK" (see - rfc3959 for more information) - not implemented yet. + RFC 3959 for more information) - not implemented yet.
3. Dependencies
@@ -101,7 +101,7 @@ Chapter 1. Admin Guide 3.1. Kamailio Modules
The following modules must be loaded before this module: - * dialog - dialog module and its decencies (tm). + * dialog - dialog module and its dependencies (tm).
3.2. External Libraries or Applications
@@ -115,17 +115,17 @@ Chapter 1. Admin Guide
4.1. qos_flag (integer)
- Keeping with Kamailio, the module will not do anything to any message - unless instructed to do so via the config script. You must set the - qos_flag value in the setflag() call of the INVITE you want the qos - module to process. But before you can do that, you need to tell the qos - module which flag value you are assigning to qos. + The module will not do anything to any message unless instructed to do + so via the config script. You must set the qos_flag value in the + setflag() call of the INVITE you want the qos module to process. But + before you can do that, you need to tell the qos module which flag + value you are assigning to qos.
In most cases when ever you set the dialog flag you will want to set the qos flag. If the dialog flag is not set and the qos flag is set, it will not have any effect.
- This parameter must be set of the module will not load. + This parameter must be set or the module will not load.
Default value is "Not set!".
diff --git a/modules/qos/doc/qos_admin.xml b/modules/qos/doc/qos_admin.xml index 88d4dc8..2e37f51 100644 --- a/modules/qos/doc/qos_admin.xml +++ b/modules/qos/doc/qos_admin.xml @@ -13,7 +13,7 @@ <title>&adminguide;</title> - <section> + <section id="qos.overview"> <title>Overview</title>
<para>The qos module provides a way to keep track of @@ -23,36 +23,42 @@ <section> <title>How it works</title> - <para>The qos module uses the dialog module to be notified of - any new or updated dialogs. It will then look for and extract - the SDP session (if present) from SIP requests and replies and - keep track of it for the entire life of a dialog.</para> + <para> + The <emphasis>qos</emphasis> module uses the + <emphasis>dialog</emphasis> module to be notified of any new or + updated dialogs. It will then look for and extract + the <acronym>SDP</acronym> session (if present) from SIP requests + and replies and keep track of it for the entire life of a dialog. + </para>
- <para>All of this happens with a properly configured dialog + <para> + All of this happens with a properly configured dialog and qos module and setting the dialog flag and the qos flag at - the time any INVITE sip message is seen. There is no + the time any INVITE SIP message is seen. There is no config script function call required to set the SDP session tracking mechanism. See the dialog module users guide for - more information.</para> + more information. + </para>
- <para>A dialog can have one or more SDP sessions active in one + <para> + A dialog can have one or more SDP sessions active in one of the following states: <itemizedlist> <listitem> - <para><emphasis>pending</emphasis> - only one end point of the + <para><emphasis>pending</emphasis> - only one endpoint of the SDP session is known. </para> </listitem> <listitem> - <para><emphasis>negotiated</emphasis> - both end points of the + <para><emphasis>negotiated</emphasis> - both endpoints of the SDP session are known. </para> </listitem> </itemizedlist> </para>
- <para>An SDP session can be established in one of the following - scenarios: + <para> + An SDP session can be established in one of the following scenarios: <itemizedlist> <listitem> <para><emphasis>INVITE/200ok</emphasis> - typical "INVITE" and @@ -60,14 +66,16 @@ </para> </listitem> <listitem> - <para><emphasis>200ok/ACK</emphasis> - "200 OK" and "ACK" SDP + <para> + <emphasis>200ok/ACK</emphasis> - "200 OK" and "ACK" SDP exchange (for calls starting with an empty INVITE). </para> </listitem> <listitem> - <para><emphasis>183/PRACK</emphasis> - early media via "183 - Session Progress" and "PRACK" (see rfc3959 for more information) - - not implemented yet. + <para> + <emphasis>183/PRACK</emphasis> - early media via "183 + Session Progress" and "PRACK" (see RFC 3959 for more information) + <emphasis>- not implemented yet</emphasis>. </para> </listitem> </itemizedlist> @@ -85,7 +93,7 @@ <listitem> <para> <emphasis>dialog</emphasis> - dialog module and - its decencies (tm). + its dependencies (tm). </para> </listitem> </itemizedlist> @@ -108,24 +116,23 @@ </section> <section> <title>Parameters</title> - <section> + <section id="qos.p.qos_flag"> <title><varname>qos_flag</varname> (integer)</title> - <para>Keeping with &kamailio;, the module will not do - anything to any message unless instructed to do so via - the config script. You must set the qos_flag - value in the setflag() call of the INVITE you want the - qos module to process. But before you can do that, you - need to tell the qos module which flag value you are - assigning to qos.</para> + <para>The module will not do anything to any message unless + instructed to do so via the config script. You must set the + <varname>qos_flag</varname> value in the <function>setflag()</function> + call of the INVITE you want the qos module to process. But + before you can do that, you need to tell the qos module which + flag value you are assigning to qos.</para>
<para>In most cases when ever you set the dialog flag you will want to set the qos flag. If the dialog flag is not set and the qos flag is set, it will not have any effect.</para>
- <para>This parameter must be set of the module will - not load.</para> + <para><emphasis>This parameter must be set or the module will + not load.</emphasis></para>
<para> <emphasis>