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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
<?xml version="1.0" encoding='ISO-8859-1'?>
<!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;
]>
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>
The EVAPI module can be used to create an event message flow
from Kamailio to any application that can connect to a TCP
socket. The remote application can also issue messages received
by Kamailio.
</para>
<para>
There is no protocol definition, it is all up to the author of
the routing script. Events can be generated for any event in
Kamailio. For 3rd party transaction control, a transaction can
be automatically suspended when sending the event, to be resumed
at a later point, maybe triggered by an incoming message on the event socket.
</para>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&kamailio; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>tm</emphasis> - (optional) needed only by
evapi_async_relay()
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&kamailio; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>libev</emphasis>
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section id="evapi.p.workers">
<title><varname>workers</varname> (int)</title>
<para>
Number of worker processes to be started to handle incoming messages
from remote applications.
</para>
<para>
<emphasis>
Default value is 1.
</emphasis>
</para>
<example>
<title>Set <varname>workers</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("evapi", "workers", 2)
...
</programlisting>
</example>
</section>
<section id="evapi.p.bind_addr">
<title><varname>bind_addr</varname> (str)</title>
<para>
Local IP and port to listen on for incoming TCP connections.
</para>
<para>
<emphasis>
Default value is "127.0.0.1:8448".
</emphasis>
</para>
<example>
<title>Set <varname>bind_addr</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("evapi", "bind_addr", "1.2.3.4:8228")
...
</programlisting>
</example>
</section>
<section id="evapi.p.netstring_format">
<title><varname>netstring_format</varname> (int)</title>
<para>
Control if messages on the socket (to and from clients)
are encapsulated in netstring format.
</para>
<para>
<emphasis>
Default value is 1 (netstring format).
</emphasis>
</para>
<example>
<title>Set <varname>netstring_format</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("evapi", "netstring_format", 0)
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Functions</title>
<section id="evapi.f.evapi_relay">
<title>
<function moreinfo="none">evapi_relay(evdata)</function>
</title>
<para>
Relay the event data give as parameter to connected applications.
The format on the network is netstring with evdata payload.
</para>
<para>
This function can be used from ANY_ROUTE.
</para>
<example>
<title><function>evapi_relay</function> usage</title>
<programlisting format="linespecific">
...
evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
...
</programlisting>
</example>
<para>
The above exaple will send the following message over tcp:
</para>
<example>
<title>TCP message</title>
<programlisting format="linespecific">
...
47:{
"event": "test",
"data": { "fU": "test" }
},
...
</programlisting>
</example>
</section>
<section id="evapi.f.evapi_async_relay">
<title>
<function moreinfo="none">evapi_async_relay(evdata)</function>
</title>
<para>
Relay the event data give as parameter to connected applications.
The format on the network is netstring with evdata payload. Before
evaluating the parameter, the request processing is suspended using
tm module.
</para>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>evapi_async_relay</function> usage</title>
<programlisting format="linespecific">
...
evapi_async_relay("{ \"event\": \"suspend\",\n \"data\":"
" { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}");
...
</programlisting>
</example>
</section>
<section id="evapi.f.evapi_close">
<title>
<function moreinfo="none">evapi_close()</function>
</title>
<para>
Close evapi current client connection.
</para>
<para>
This function can be used from ANY_ROUTE.
</para>
<example>
<title><function>evapi_evapi</function> usage</title>
<programlisting format="linespecific">
...
event_route[evapi:connection-new] {
if($evapi(srcaddr)!="127.0.0.1") {
evapi_close();
exit;
}
}
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Event routes</title>
<section>
<title>
<function moreinfo="none">evapi:connection-new</function>
</title>
<para>
If defined, the module calls event_route[evapi:connection-new]
when a new client is connected.
</para>
<programlisting format="linespecific">
...
event_route[evapi:connection-new] {
xlog("new connection from $evapi(srcaddr):$evapi(srcport)\n");
}
...
</programlisting>
</section>
<section>
<title>
<function moreinfo="none">evapi:connection-closed</function>
</title>
<para>
If defined, the module calls event_route[evapi:connection-closed]
when a client connection is closed.
</para>
<programlisting format="linespecific">
...
event_route[evapi:connection-closed] {
xlog("connection closed by $evapi(srcaddr):$evapi(srcport)\n");
}
...
</programlisting>
</section>
<section>
<title>
<function moreinfo="none">evapi:message-received</function>
</title>
<para>
If defined, the module calls event_route[evapi:message-received]
when a message is received from a client.
</para>
<programlisting format="linespecific">
...
event_route[evapi:message-received] {
xlog("received [$evapi(msg)] from $evapi(srcaddr):$evapi(srcport)\n");
}
...
</programlisting>
</section>
</section>
<section>
<title>Exported pseudo-variables</title>
<itemizedlist>
<listitem><para>
<emphasis>$evapi(srcaddr)</emphasis> - source ip
</para></listitem>
<listitem><para>
<emphasis>$evapi(srcport)</emphasis> - source port
</para></listitem>
<listitem><para>
<emphasis>$evapi(msg)</emphasis> - received event message
</para></listitem>
<listitem><para>
<emphasis>$evapi(conidx)</emphasis> - internal connection index
</para></listitem>
</itemizedlist>
<para>
Exported pseudo-variables are documented at &kamwikilink;.
</para>
</section>
</chapter>
|
