%docentities; ]> &adminguide;
Overview The qos module provides a way to keep track of per dialog SDP session(s).
How it works 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. 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 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 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 RFC 3959 for more information) - not implemented yet.
Dependencies
&kamailio; Modules The following modules must be loaded before this module: dialog - dialog module and its dependencies (tm).
External Libraries or Applications The following libraries or applications must be installed before running &kamailio; with this module loaded: None.
Parameters
<varname>qos_flag</varname> (integer) 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 or the module will not load. Default value is Not set!. Set <varname>qos_flag</varname> parameter ... modparam("dialog", "dlg_flag", 5) modparam("qos", "qos_flag", 7) ... route { ... if (method=="INVITE") { setflag(5); # set the dialog flag setflag(7); # Set the qos flag } ... }
Functions There are no exported functions that could be used in scripts.
Statistics There are no exported statistics for the qos module.
MI Commands There are no exported MI functions for the qos module. Check the dialog MI functions for a way to inspect the internals of a dialog.
Exported pseudo-variables There are no exported pseudo-variables for the qos module.
Installation and Running Just load the module and remember to set the flag.