Merge remote branch 'origin/sr_3.0'
[sip-router] / modules / sanity / doc / params.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
5 <!-- Include general documentation entities -->
6 <!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
7 %docentities;
8
9 ]>
10
11 <section id="sanity.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
12     <sectioninfo>
13         <revhistory>
14             <revision>
15                 <revnumber>$Revision$</revnumber>
16                 <date>$Date$</date>
17             </revision>
18         </revhistory>
19     </sectioninfo>
20
21     <title>Parameters</title>
22
23     <section id="default_checks">
24         <title><varname>default_checks</varname> (integer)</title>
25         <para>
26                 This parameter determines which of the checks from the sanity
27                 module are executed if no parameter was given to the sanity_check
28                 function call. By default all implemented checks are included
29                 in the execution of the sanity_check function. The integer value
30                 is the sum of the check numbers which should be executed by default.
31         </para>
32         <para>
33             Default value is 999. This resolves to the following list of
34                 checks: ruri_sip_version (1), ruri_scheme (2), required_headers (4),
35                 cseq_method (32), cseq_value (64), cotent_length (128), 
36                 expires_value (256), proxy_require (512).
37         </para>
38         <example>
39             <title>Set <varname>default_checks</varname> parameter</title>
40             <programlisting>
41 ...
42 modparam("sanity", "default_checks", "1")
43 ...
44             </programlisting>
45         </example>
46     </section>
47
48         <section id="uri_checks">
49         <title><varname>uri_checks</varname> (integer)</title>
50         <para>
51                 This parameter determines which URIs are going to be checked
52                 if the 'parse uri' will be executed.
53         </para>
54         <para>
55                 Default value is 7. This resolves to the following list of
56                 parsed URIs: Request RUI (1), From URI (2) and To URI (4).
57         </para>
58         </section>
59
60         <section id="proxy_require">
61         <title><varname>proxy_require</varname> (string)</title>
62         <para>
63                 This parameter set the list of supported extensions for this SIP-router.
64                 The value is expected as comma separated list of the extensions.
65                 This list is separated into single tokens. Each token from
66                 a proxy require header will be compare to the tokens from this
67                 list.
68         </para>
69         <example>
70             <title>Set <varname>proxy_require</varname> parameter</title>
71             <programlisting>
72 ...
73 modparam("sanity", "proxy_require", "foo, bar")
74 ...
75             </programlisting>
76         </example>
77         </section>
78
79
80 </section>