You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules_s/nathelper/doc/params.xml

75 lines
2.1 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="nathelper.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>Parameters</title>
<section id="natping_interval">
<title><varname>natping_interval</varname> (integer)</title>
<para>
Period of time in seconds between sending short UDP packets to
all currently registered UAs to keep their NAT bindings
alive. Value of 0 disables this functionality.
</para>
<para>
Default value is 0.
</para>
<example>
<title>Set <varname>natping_interval</varname> parameter</title>
<programlisting>
...
modparam("nathelper", "natping_interval", 10)
...
</programlisting>
</example>
</section>
<section id="ping_nated_only">
<title><varname>ping_nated_only</varname> (integer)</title>
<para>
If this variable is set then only contacts that have "behind_NAT"
flag in user location database set set will get ping.
</para>
<para>
Default value is 0.
</para>
<example>
<title>Set <varname>ping_nated_only</varname> parameter</title>
<programlisting>
...
modparam("nathelper", "ping_nated_only", 1)
...
</programlisting>
</example>
</section>
<section id="received_avp">
<title><varname>received_avp</varname> (integer)</title>
<para>
The number of the Attribute-Value-Pair (AVP) used to store the URI
containing the received IP, port, and protocol. The URI is created
by fix_nated_register function of nathelper module and the
attribute is then used by the registrar to store the received
parameters. Do not forget to change the value of corresponding
parameter in registrar module if you change the value of this
parameter.
</para>
<para>
Default value is 42.
</para>
<example>
<title>Set <varname>received_avp</varname> parameter</title>
<programlisting>
...
modparam("nathelper", "received_avp", 43)
...
</programlisting>
</example>
</section>
</section>