Skip to content

Commit

Permalink
dialog: docs for rpc command dlg.stats_active
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Jul 13, 2018
1 parent ebb1490 commit c005354
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions src/modules/dialog/doc/dialog_admin.xml
Expand Up @@ -2603,6 +2603,45 @@ if(has_totag()) {
</section>
</section>

<section id="dlg.r.stats_active">
<title>dlg.stats_active</title>
<para>
Get stats about active dialogs by scanning internal list of dialogs
(not relying on core stats framework).
</para>
<para>Name: <emphasis>dlg.stats_active</emphasis></para>
<para>Parameters: none.</para>
<para>Returned fields</para>
<itemizedlist>
<listitem><para>
<emphasis>starting</emphasis> - initial INVITE has been processed,
no ringing or 1xx has been received.
</para></listitem>
<listitem><para>
<emphasis>connecting</emphasis> - initial INVITE was forwarded
and rining or 1xx has been received.
</para></listitem>
<listitem><para>
<emphasis>answering</emphasis> - initial INVITE received 200ok,
but ACK was not handled yet.
</para></listitem>
<listitem><para>
<emphasis>ongoing</emphasis> - ongoing active dialog, after the
ACK was processed.
</para></listitem>
<listitem><para>
<emphasis>all</emphasis> - all active dialogs, respectively the
sum of the above values.
</para></listitem>
</itemizedlist>
<para>RPC Command Format:</para>
<programlisting format="linespecific">
...
&kamcmd; dlg.stats_active
...
</programlisting>
</section>
</section>

<section>
<title>Exported Variables</title>
Expand Down

0 comments on commit c005354

Please sign in to comment.