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
|
Pseudo-Variables Module
Daniel-Constantin Mierla
asipto.com
<daniel@asipto.com>
Edited by
Daniel-Constantin Mierla
<daniel@asipto.com>
Copyright 2008-2011 Daniel-Constantin Mierla (asipto.com)
Copyright 2011 Juha Heinanen
Copyright 2013 Olle E. Johansson, Edvina AB
__________________________________________________________________
Table of Contents
1. Admin Guide
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. shvset (string)
3.2. varset (string)
3.3. avp_aliases (string)
4. Functions
4.1. pv_isset(pvar)
4.2. pv_unset(pvar)
4.3. is_int(pvar)
4.4. typeof(pvar, vtype)
4.5. not_empty(pvar)
5. MI Commands
5.1. shv_set
5.2. shv_get
6. RPC Commands
6.1. pv.shvSet
6.2. pv.shvGet
List of Examples
1.1. shvset parameter usage
1.2. varset parameter usage
1.3. avp_aliases parameter usage
1.4. pv_isset usage
1.5. pv_unset usage
1.6. is_int() usage
1.7. typeof() usage
1.8. not_empty() usage
1.9. shv_set usage
1.10. shv_get usage
Chapter 1. Admin Guide
Table of Contents
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. shvset (string)
3.2. varset (string)
3.3. avp_aliases (string)
4. Functions
4.1. pv_isset(pvar)
4.2. pv_unset(pvar)
4.3. is_int(pvar)
4.4. typeof(pvar, vtype)
4.5. not_empty(pvar)
5. MI Commands
5.1. shv_set
5.2. shv_get
6. RPC Commands
6.1. pv.shvSet
6.2. pv.shvGet
1. Overview
This module collects the core pseudo-variables that can be used in
configuration file. They are listed in Dokuwiki:
http://www.kamailio.org/wiki/, in Pseudo-Variables section
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
2.1. Kamailio Modules
The following modules must be loaded before this module:
* No dependencies on other Kamailio modules.
2.2. External Libraries or Applications
The following libraries or applications must be installed before
running Kamailio with this module loaded:
* None.
3. Parameters
3.1. shvset (string)
3.2. varset (string)
3.3. avp_aliases (string)
3.1. shvset (string)
Set the value of a shared variable ($shv(name)). The parameter can be
set many times.
The value of the parameter has the format: _name_ '=' _type_ ':'
_value_
* _name_: shared variable name
* _type_: type of the value
+ "i": integer value
+ "s": string value
* _value_: value to be set
Default value is "NULL".
Example 1.1. shvset parameter usage
...
modparam("pv", "shvset", "debug=i:1")
modparam("pv", "shvset", "pstngw=s:sip:10.10.10.10")
...
3.2. varset (string)
Set the value of a script variable ($var(name)). The parameter can be
set many times.
The value of the parameter has the format: _name_ '=' _type_ ':'
_value_
* _name_: shared variable name
* _type_: type of the value
+ "i": integer value
+ "s": string value
* _value_: value to be set
Default value is "NULL".
Example 1.2. varset parameter usage
...
modparam("pv", "varset", "init=i:1")
modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
...
3.3. avp_aliases (string)
Define aliases for PV AVP names.
Default value is NULL.
Example 1.3. avp_aliases parameter usage
...
modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
...
4. Functions
4.1. pv_isset(pvar)
4.2. pv_unset(pvar)
4.3. is_int(pvar)
4.4. typeof(pvar, vtype)
4.5. not_empty(pvar)
4.1. pv_isset(pvar)
Return true if a PV value is different than 'null'.
Meaning of the parameters is as follows:
* pvar - pvar identifier.
This function can be used from ANY_ROUTE.
Example 1.4. pv_isset usage
...
if(pv_isset("$avp("s:x")"))
{
...
}
...
4.2. pv_unset(pvar)
Unset the value of the PV (e.g., delete AVP, set to null).
Meaning of the parameters is as follows:
* pvar - pvar identifier.
This function can be used from ANY_ROUTE.
Example 1.5. pv_unset usage
...
pv_unset("$avp("s:x")");
...
4.3. is_int(pvar)
Function checks if pvar argument contains integer value and returns 1
if it does and -1 otherwise.
Function can be used from all kinds of routes.
Example 1.6. is_int() usage
...
if (is_int("$var(foo)")) {
xlog("L_INFO", "variable foo contains integer value\n");
}
...
4.4. typeof(pvar, vtype)
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.
Function can be used from ANYROUTE.
Example 1.7. typeof() usage
...
if (typeof("$var(foo)", "str")) {
xdbg("variable foo is a string\n");
}
...
4.5. not_empty(pvar)
Returns true if the pseudo-variables has the type string and is not
empty value.
Function can be used from all kinds of routes.
Example 1.8. not_empty() usage
...
if (not_empty("$var(foo)")) {
append_hf("X-Foo: $var(foo)\r\n");
}
...
5. MI Commands
5.1. shv_set
5.2. shv_get
5.1. shv_set
Set the value of a shared variable ($shv(name)).
Parameters:
* _name_: shared variable name
* _type_: type of the value
+ "int": integer value
+ "str": string value
* _value_: value to be set
MI FIFO Command Format:
:shv_set:_reply_fifo_file_
_name_
_type_
_value_
_empty_line_
Example 1.9. shv_set usage
...
$ kamctl fifo shv_set debug int 0
...
5.2. shv_get
Get the value of a shared variable ($shv(name)).
Parameters:
* _name_: shared variable name. If this parameter is missing, all
shared variables are returned.
MI FIFO Command Format:
:shv_get:_reply_fifo_file_
_name_
_empty_line_
Example 1.10. shv_get usage
...
$ kamctl fifo shv_get debug
$ kamctl fifo shv_get
...
6. RPC Commands
6.1. pv.shvSet
6.2. pv.shvGet
6.1. pv.shvSet
Set the value of a shared variable ($shv(name)).
Parameters:
* _name_: shared variable name
* _type_: type of the value
+ "int": integer value
+ "str": string value
* _value_: value to be set
6.2. pv.shvGet
Get the value of a shared variable ($shv(name)).
Parameters:
* _name_: shared variable name
If no name is given, all shared variables are listed
|
