Module: kamailio
Branch: master
Commit: 95aad5185c5622dea9b3edb3a2711b65ad146675
URL:
https://github.com/kamailio/kamailio/commit/95aad5185c5622dea9b3edb3a2711b6…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2016-01-24T13:29:56+01:00
dispatcher: documentation for rpc command dispatcher.ping_active
---
Modified: modules/dispatcher/doc/dispatcher_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/95aad5185c5622dea9b3edb3a2711b6…
Patch:
https://github.com/kamailio/kamailio/commit/95aad5185c5622dea9b3edb3a2711b6…
---
diff --git a/modules/dispatcher/doc/dispatcher_admin.xml
b/modules/dispatcher/doc/dispatcher_admin.xml
index 6f44754..c79ecaa 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -1474,6 +1474,41 @@ onreply_route {
</programlisting>
</section>
+ <section id="dispatcher.rpc.ping_active">
+ <title>
+ <function moreinfo="none">dispatcher.ping_active</function>
+ </title>
+ <para>
+ Sets the global state for sending keepalive requests to destinations.
+ </para>
+ <para>
+ Name: <emphasis>dispatcher.ping_active</emphasis>
+ </para>
+ <para>Parameters:</para>
+ <itemizedlist>
+ <listitem><para>_state_ : state of sending keepalives</para>
+ <itemizedlist>
+ <listitem><para> <quote>0</quote>: inactive
(don't send)</para></listitem>
+ <listitem><para> <quote>1</quote>: active
(send)</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <para>
+ If the state parameter is missing, the current state is returned.
+ When state is changed, new and old values of the state are returned.
+ Default value for state is 1.
+ </para>
+ <para>
+ Example:
+ </para>
+<programlisting format="linespecific">
+...
+# prototype: &kamcmd; dispatcher.ping_active _state_
+&kamcmd; dispatcher.ping_active 0
+...
+</programlisting>
+ </section>
+
</section>
<section id="dispatcher.ex.install">