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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
<?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>
This module collects the core pseudo-variables that can be used in
configuration file. They are listed in Dokuwiki:
<ulink url="http://www.kamailio.org/wiki/">http://www.kamailio.org/wiki/</ulink>,
in Pseudo-Variables section
</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>No dependencies on other &kamailio; modules</emphasis>.
</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>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section>
<title><varname>shvset</varname> (string)</title>
<para>
Set the value of a shared variable ($shv(name)). The parameter
can be set many times.
</para>
<para>
The value of the parameter has the format:
_name_ '=' _type_ ':' _value_
</para>
<itemizedlist>
<listitem><para>_name_: shared variable name</para></listitem>
<listitem><para>_type_: type of the value</para>
<itemizedlist>
<listitem><para> <quote>i</quote>: integer value </para></listitem>
<listitem><para> <quote>s</quote>: string value </para></listitem>
</itemizedlist>
</listitem>
<listitem><para>_value_: value to be set</para></listitem>
</itemizedlist>
<para>
Default value is <quote>NULL</quote>.
</para>
<example>
<title><varname>shvset</varname> parameter usage</title>
<programlisting format="linespecific">
...
modparam("pv", "shvset", "debug=i:1")
modparam("pv", "shvset", "pstngw=s:sip:10.10.10.10")
...
</programlisting>
</example>
</section>
<section>
<title><varname>varset</varname> (string)</title>
<para>
Set the value of a script variable ($var(name)). The parameter
can be set many times.
</para>
<para>
The value of the parameter has the format:
_name_ '=' _type_ ':' _value_
</para>
<itemizedlist>
<listitem><para>_name_: shared variable name</para></listitem>
<listitem><para>_type_: type of the value</para>
<itemizedlist>
<listitem><para> <quote>i</quote>: integer value </para></listitem>
<listitem><para> <quote>s</quote>: string value </para></listitem>
</itemizedlist>
</listitem>
<listitem><para>_value_: value to be set</para></listitem>
</itemizedlist>
<para>
Default value is <quote>NULL</quote>.
</para>
<example>
<title><varname>varset</varname> parameter usage</title>
<programlisting format="linespecific">
...
modparam("pv", "varset", "init=i:1")
modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
...
</programlisting>
</example>
</section>
<section>
<title><varname>avp_aliases</varname> (string)</title>
<para>
Define aliases for PV AVP names.
</para>
<para>
<emphasis>
Default value is NULL.
</emphasis>
</para>
<example>
<title><varname>avp_aliases</varname> parameter usage</title>
<programlisting format="linespecific">
...
modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Functions</title>
<section>
<title><function moreinfo="none">pv_isset(pvar)</function></title>
<para>
Return true if a PV value is different than 'null'.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para>
<emphasis>pvar</emphasis> - pvar identifier.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from ANY_ROUTE.
</para>
<example>
<title><function>pv_isset</function> usage</title>
<programlisting format="linespecific">
...
if(pv_isset("$avp("s:x")"))
{
...
}
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">pv_unset(pvar)</function></title>
<para>
Unset the value of the PV (e.g., delete AVP, set to null).
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para>
<emphasis>pvar</emphasis> - pvar identifier.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from ANY_ROUTE.
</para>
<example>
<title><function>pv_unset</function> usage</title>
<programlisting format="linespecific">
...
pv_unset("$avp("s:x")");
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">is_int(pvar)</function>
</title>
<para>
Function checks if pvar argument contains integer value
and returns 1 if it does and -1 otherwise.
</para>
<para>
Function can be used from all kinds of routes.
</para>
<example>
<title><function>is_int()</function> usage</title>
<programlisting format="linespecific">
...
if (is_int("$var(foo)")) {
xlog("L_INFO", "variable foo contains integer value\n");
}
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">typeof(pvar, vtype)</function>
</title>
<para>
Returns true if the type of pseudo-variable matches the second
parameter. The second parameter can be: 'int' - type is integer;
'str' - type is string; 'null' - type is null.
</para>
<para>
Function can be used from ANYROUTE.
</para>
<example>
<title><function>typeof()</function> usage</title>
<programlisting format="linespecific">
...
if (typeof("$var(foo)", "str")) {
xdbg("variable foo is a string\n");
}
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">not_empty(pvar)</function>
</title>
<para>
Returns true if the pseudo-variables has the type string and
is not empty value.
</para>
<para>
Function can be used from all kinds of routes.
</para>
<example>
<title><function>not_empty()</function> usage</title>
<programlisting format="linespecific">
...
if (not_empty("$var(foo)")) {
append_hf("X-Foo: $var(foo)\r\n");
}
...
</programlisting>
</example>
</section>
</section>
<section>
<title><acronym>MI</acronym> Commands</title>
<section>
<title><function moreinfo="none">shv_set</function></title>
<para>
Set the value of a shared variable ($shv(name)).
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>_name_: shared variable name</para></listitem>
<listitem><para>_type_: type of the value</para>
<itemizedlist>
<listitem><para> <quote>int</quote>: integer value </para></listitem>
<listitem><para> <quote>str</quote>: string value </para></listitem>
</itemizedlist>
</listitem>
<listitem><para>_value_: value to be set</para></listitem>
</itemizedlist>
<para>
MI FIFO Command Format:
</para>
<programlisting format="linespecific">
:shv_set:_reply_fifo_file_
_name_
_type_
_value_
_empty_line_
</programlisting>
<example>
<title><function moreinfo="none">shv_set</function> usage</title>
<programlisting format="linespecific">
...
$ &ctltool; fifo shv_set debug int 0
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">shv_get</function></title>
<para>
Get the value of a shared variable ($shv(name)).
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>_name_: shared variable name. If this parameter
is missing, all shared variables are returned.</para></listitem>
</itemizedlist>
<para>
MI FIFO Command Format:
</para>
<programlisting format="linespecific">
:shv_get:_reply_fifo_file_
_name_
_empty_line_
</programlisting>
<example>
<title><function moreinfo="none">shv_get</function> usage</title>
<programlisting format="linespecific">
...
$ &ctltool; fifo shv_get debug
$ &ctltool; fifo shv_get
...
</programlisting>
</example>
</section>
</section>
<section>
<title>RPC Commands</title>
<section>
<title><function moreinfo="none">pv.shvSet</function></title>
<para>
Set the value of a shared variable ($shv(name)).
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>_name_: shared variable name</para></listitem>
<listitem><para>_type_: type of the value</para>
<itemizedlist>
<listitem><para> <quote>int</quote>: integer value </para></listitem>
<listitem><para> <quote>str</quote>: string value </para></listitem>
</itemizedlist>
</listitem>
<listitem><para>_value_: value to be set</para></listitem>
</itemizedlist>
</section>
<section>
<title><function moreinfo="none">pv.shvGet</function></title>
<para>
Get the value of a shared variable ($shv(name)).
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>_name_: shared variable name</para></listitem>
</itemizedlist>
<para>If no name is given, all shared variables are listed</para>
</section>
</section>
</chapter>
|
