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/counters/doc/counters_rpc.xml

97 lines
2.4 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"
[ <!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]
>
<section id="cnts.rpcs" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>counters RPC Functions</title>
<section id="cnt.get">
<title> <function>cnt.get group counter_name</function></title>
<para>
Get the value of the counter identified by group.counter_name.
</para>
<example>
<title><function>cnt.get grp counter_name</function> usage</title>
<programlisting>
$ &sercmd; cnt.get script foo
</programlisting>
</example>
</section>
<section id="cnt.reset">
<title> <function>cnt.reset group counter_name</function></title>
<para>
Resets the counter identified by group.counter_name.
</para>
<example>
<title><function>cnt.reset grp name</function> usage</title>
<programlisting>
$ &sercmd; cnt.reset script foo
</programlisting>
</example>
</section>
<section id="cnt.grps_list">
<title> <function>cnt.grps_list</function></title>
<para>
Lists all the declared counter groups.
</para>
<example>
<title><function>cnt.grps_list</function> usage</title>
<programlisting>
$ &sercmd; cnt.grps_list
</programlisting>
</example>
</section>
<section id="cnt.var_list">
<title> <function>cnt.var_list group</function></title>
<para>
Lists all the names of all the counters belonging to the
specified group.
</para>
<example>
<title><function>cnt.var_list group</function> usage</title>
<programlisting>
$ &sercmd; cnt.var_list script
</programlisting>
</example>
</section>
<section id="cnt.grp_get_all">
<title> <function>cnt.grp_get_all</function></title>
<para>
Lists all the counter names and their values in the
specified group.
</para>
<example>
<title><function>cnt.var_list group</function> usage</title>
<programlisting>
$ &sercmd; cnt.grp_get_all script
</programlisting>
</example>
</section>
<section id="cnt.help">
<title> <function>cnt.help group counter_name</function></title>
<para>
Displays the counter description.
</para>
<example>
<title><function>cnt.help grp name</function> usage</title>
<programlisting>
$ &sercmd; cnt.help script foo
</programlisting>
</example>
</section>
</section>