File: ctl_rpc.xml

package info (click to toggle)
kamailio 4.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 56,100 kB
  • sloc: ansic: 552,832; xml: 166,484; sh: 8,659; makefile: 7,676; sql: 6,235; perl: 3,487; yacc: 3,428; python: 1,457; cpp: 1,219; php: 1,047; java: 449; pascal: 194; cs: 40; awk: 27
file content (63 lines) | stat: -rw-r--r-- 1,640 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?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>
	</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>