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/ctl/doc/rpc.xml

70 lines
1.7 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]>
<section id="ctl.rpcs" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
<revhistory>
<revision>
<revnumber>$Revision$</revnumber>
<date>$Date$</date>
</revision>
</revhistory>
</sectioninfo>
<title>SIP-router RPC Functions</title>
<section id="ctl.listen">
<title> <function>ctl.listen</function></title>
<para>
List all the sockets on which the ctl module listens.
</para>
<example>
<title><function>print</function> usage</title>
<programlisting>
$ &sercmd; -f"[%v] %v:%v %v\n" ctl.listen
[binrpc] unix_stream:/tmp/&ctlsocket;
# note: the above command is equivalent with &sercmd; listen
</programlisting>
</example>
</section>
<section id="ctl.connections">
<title> <function>ctl.connections</function></title>
<para>
Returns the number of open binrpc connections (to the ctl module).
</para>
<example>
<title><function>ctl.connections</function> usage</title>
<programlisting>
$ &sercmd; ctl.connections
1
</programlisting>
</example>
</section>
<section id="ctl.who">
<title> <function>ctl.who</function></title>
<para>
List open binrpc connections (to the ctl module).
</para>
<example>
<title><function>ctl.who</function> usage</title>
<programlisting>
$ &sercmd; -f"[%v] %v: %v %v -> %v %v\n" ctl.who
[binrpc] unix_stream: &lt;anonymous unix socket&gt; -> /tmp/&ctlsocket;
# note the above command is equivalent to &sercmd; who
</programlisting>
</example>
</section>
</section>