Skip to content

Commit

Permalink
usrloc: docs for ka_timeout module parameter
Browse files Browse the repository at this point in the history
(cherry picked from commit 2e9d4e2)
  • Loading branch information
miconda committed Sep 22, 2020
1 parent f5eb642 commit 79ec049
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions src/modules/usrloc/doc/usrloc_admin.xml
Expand Up @@ -604,8 +604,8 @@ modparam("usrloc", "desc_time_order", 1)
<title><varname>timer_interval</varname> (int)</title>
<para>
Number of seconds between two timer runs. The module uses a timer to
delete expired contacts, synchronize with database and other tasks,
that need to be run periodically.
delete expired contacts, synchronize with database, send keepalives
and other tasks, that need to be run periodically.
</para>
<para>
<emphasis>
Expand Down Expand Up @@ -1424,6 +1424,36 @@ modparam("usrloc", "ka_filter", 1)
</example>
</section>

<section id="usrloc.p.ka_timeout">
<title><varname>ka_timeout</varname> (int)</title>
<para>
The parameter sets the interval in seconds after which a
contact is removed from location table if it does not reply to SIP
keepalives (usually OPTIONS ping requests).
</para>
<para>
The features is available only for contacts that are stored in memory
(not working for db only mode of the usrloc module).
</para>
<para>
Keepalives are sent stateless, not using TM module. The value of this
parameter has to be few times higher than timer interval.
</para>
<para>
<emphasis>
Default value is <quote>0</quote> (feature disabled).
</emphasis>
</para>
<example>
<title>Set <varname>ka_timeout</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("usrloc", "ka_timeout", 120)
...
</programlisting>
</example>
</section>

<section id="usrloc.p.ka_loglevel">
<title><varname>ka_loglevel</varname> (int)</title>
<para>
Expand Down

0 comments on commit 79ec049

Please sign in to comment.