Browse code

all: replaced db_url static value with &defaultrodb; in docs

- regenerated the readmes for modules/ and modules_k/

Daniel-Constantin Mierla authored on 18/10/2012 12:36:46
Showing 59 changed files
... ...
@@ -64,7 +64,7 @@ Chapter 1. Admin Guide
64 64
 
65 65
    Async uses t_suspend() and t_continue() from the TM and TMX modules.
66 66
 
67
-   Note that after invoking the an asynchronous operation, the processing
67
+   Note that after invoking the asynchronous operation, the processing
68 68
    will continue later in another application process. Therefore variables
69 69
    stored in private memory should not be used, try to use shared memory
70 70
    if you want to get values after the processing is resumed (e.g.,
... ...
@@ -10,7 +10,7 @@ Ramona-Elena Modroiu
10 10
 
11 11
    <ramona@rosdev.ro>
12 12
 
13
-   Copyright © 2004, 2005 Voice Sistem SRL
13
+   Copyright � 2004, 2005 Voice Sistem SRL
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -239,7 +239,7 @@ modparam("avpops","use_domain",1)
239 239
 
240 240
    Name of column containing the uuid (unique user id).
241 241
 
242
-   Default value is “uuid”.
242
+   Default value is "uuid".
243 243
 
244 244
    Example 1.5. Set uuid_column parameter
245 245
 ...
... ...
@@ -250,7 +250,7 @@ modparam("avpops","uuid_column","uuid")
250 250
 
251 251
    Name of column containing the username.
252 252
 
253
-   Default value is “username”.
253
+   Default value is "username".
254 254
 
255 255
    Example 1.6. Set username_column parameter
256 256
 ...
... ...
@@ -261,7 +261,7 @@ modparam("avpops","username_column","username")
261 261
 
262 262
    Name of column containing the domain name.
263 263
 
264
-   Default value is “domain”.
264
+   Default value is "domain".
265 265
 
266 266
    Example 1.7. Set domain_column parameter
267 267
 ...
... ...
@@ -272,7 +272,7 @@ modparam("avpops","domain_column","domain")
272 272
 
273 273
    Name of column containing the attribute name (AVP name).
274 274
 
275
-   Default value is “attribute”.
275
+   Default value is "attribute".
276 276
 
277 277
    Example 1.8. Set attribute_column parameter
278 278
 ...
... ...
@@ -283,7 +283,7 @@ modparam("avpops","attribute_column","attribute")
283 283
 
284 284
    Name of column containing the AVP value.
285 285
 
286
-   Default value is “value”.
286
+   Default value is "value".
287 287
 
288 288
    Example 1.9. Set value_column parameter
289 289
 ...
... ...
@@ -294,7 +294,7 @@ modparam("avpops","value_column","value")
294 294
 
295 295
    Name of integer column containing the AVP type.
296 296
 
297
-   Default value is “type”.
297
+   Default value is "type".
298 298
 
299 299
    Possible column values are
300 300
      * 0 - AVP with string name and string value
... ...
@@ -322,7 +322,7 @@ modparam("avpops","type_column","type")
322 322
           + 'value_type='('integer'|'string')
323 323
           + 'table='string
324 324
 
325
-   Default value is “NULL”.
325
+   Default value is "NULL".
326 326
 
327 327
    Example 1.11. Set db_scheme parameter
328 328
 ...
... ...
@@ -346,7 +346,7 @@ modparam("avpops","db_scheme",
346 346
    5.12. is_avp_set(name)
347 347
    5.13. avp_print()
348 348
 
349
-5.1.  avp_db_load(source,name)
349
+5.1. avp_db_load(source,name)
350 350
 
351 351
    Loads from DB into memory the AVPs corresponding to the given source.
352 352
    If given, it sets the script flags for loaded AVPs. It returns true if
... ...
@@ -384,7 +384,7 @@ avp_db_load("$uuid","$avp(s:404fwd)/fwd_table");
384 384
 avp_db_load("$ru","$avp(i1:123)/$some_scheme");
385 385
 ...
386 386
 
387
-5.2.  avp_db_store(source,name)
387
+5.2. avp_db_store(source,name)
388 388
 
389 389
    Stores to DB the AVPs corresponding to the given source.
390 390
 
... ...
@@ -400,7 +400,7 @@ avp_db_store("$tu","$avp(i:678)");
400 400
 avp_db_store("$ru/username","$avp(email)");
401 401
 ...
402 402
 
403
-5.3.  avp_db_delete(source,name)
403
+5.3. avp_db_delete(source,name)
404 404
 
405 405
    Deletes from DB the AVPs corresponding to the given source.
406 406
 
... ...
@@ -417,7 +417,7 @@ avp_db_delete("$ru/username","$avp(email)");
417 417
 avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
418 418
 ...
419 419
 
420
-5.4.  avp_db_query(query[,dest])
420
+5.4. avp_db_query(query[,dest])
421 421
 
422 422
    Make a database query and store the result in AVPs.
423 423
 
... ...
@@ -431,8 +431,8 @@ avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
431 431
        used in the query makes you vulnerable to SQL injection, e.g. make
432 432
        it possible for an outside attacker to alter your database content.
433 433
      * dest - a list with AVP names where to store the result. The format
434
-       is “$avp(name1);$avp(name2);...”. If this parameter is ommited, the
435
-       result is stored in “$avp(i:1);$avp(i:2);...”. If the result gives
434
+       is "$avp(name1);$avp(name2);...". If this parameter is ommited, the
435
+       result is stored in "$avp(i:1);$avp(i:2);...". If the result gives
436 436
        many rows, then multiple AVPs with corresponding name will be
437 437
        added. The value type of the AVP (string or integer) will be
438 438
        derived from the type of the columns. Please note that only this
... ...
@@ -455,7 +455,7 @@ avp_db_query("select password, ha1 from subscriber where username='$tu'",
455 455
 avp_db_query("delete from subscriber");
456 456
 ...
457 457
 
458
-5.5.  avp_delete(name)
458
+5.5. avp_delete(name)
459 459
 
460 460
    Deletes from memory the AVPs with name or, if empty, all AVPs.
461 461
 
... ...
@@ -463,7 +463,8 @@ avp_db_query("delete from subscriber");
463 463
      * name - which AVPs will be deleted from memory. Parameter syntax is:
464 464
           + name = (matching_flags|avp_name|avp_alias)['/'flag]
465 465
           + matching_flags = please refer to avp_db_load() function
466
-          + flag = 'g'|'G'
466
+          + flag = 'g'|'G' = deletes not only the last value but the
467
+            complete AVP.
467 468
 
468 469
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
469 470
    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
... ...
@@ -476,7 +477,7 @@ avp_delete("i");
476 477
 avp_delete("a3");
477 478
 ...
478 479
 
479
-5.6.  avp_pushto(destination,name)
480
+5.6. avp_pushto(destination,name)
480 481
 
481 482
    Pushes the value of AVP(s) into the SIP message.
482 483
 
... ...
@@ -506,7 +507,7 @@ avp_pushto("$du","$avp(i:679)");
506 507
 avp_pushto("$br","$avp(i:680)");
507 508
 ...
508 509
 
509
-5.7.  avp_check(name,op_value)
510
+5.7. avp_check(name,op_value)
510 511
 
511 512
    Checks the value of the AVP(s) against an operator and value.
512 513
 
... ...
@@ -548,7 +549,7 @@ avp_check("$avp(s:foo)","re/sip:.*@bar.net/g");
548 549
 avp_check("$avp(s:foo)","fm/$avp(fm_avp)/g");
549 550
 ...
550 551
 
551
-5.8.  avp_copy(old_name,new_name)
552
+5.8. avp_copy(old_name,new_name)
552 553
 
553 554
    Copy / move an avp under a new name.
554 555
 
... ...
@@ -569,7 +570,7 @@ avp_copy("$avp(i:678)", "$avp(s:345)/g");
569 570
 avp_copy("$avp(old)","$avp(new)/gd");
570 571
 ...
571 572
 
572
-5.9.  avp_printf(dest, format)
573
+5.9. avp_printf(dest, format)
573 574
 
574 575
    NOTE: since Kamailio 1.3.0 the function has been moved to core and it
575 576
    is an alias to pv_printf().
... ...
@@ -593,7 +594,7 @@ avp_copy("$avp(old)","$avp(new)/gd");
593 594
 avp_printf("$avp(i:20)", "This is a $rm request with call-id $hdr(call-id)");
594 595
 ...
595 596
 
596
-5.10.  avp_subst(avps, subst)
597
+5.10. avp_subst(avps, subst)
597 598
 
598 599
    Perl/sed-like subst applied to AVPs having string value.
599 600
 
... ...
@@ -635,7 +636,7 @@ avp_subst("$avp(i:678)/$avp(i:679)/g", "/(.*)@(.*)/\1@$rd/");
635 636
    after the first src_avp is processed, it will be added in avp list and
636 637
    next processing will use it.
637 638
 
638
-5.11.  avp_op(name,op_value)
639
+5.11. avp_op(name,op_value)
639 640
 
640 641
    Different integer operations with avps.
641 642
 
... ...
@@ -667,7 +668,7 @@ avp_op("$avp(i:678)", "add/i:345/g");
667 668
 avp_op("$avp(number)","sub/$avp(number2)/d");
668 669
 ...
669 670
 
670
-5.12.  is_avp_set(name)
671
+5.12. is_avp_set(name)
671 672
 
672 673
    Check if any AVP with name is set.
673 674
 
... ...
@@ -686,7 +687,7 @@ if(is_avp_set("$avp(i:678)"))
686 687
     log("AVP with integer id 678 exists\n");
687 688
 ...
688 689
 
689
-5.13.  avp_print()
690
+5.13. avp_print()
690 691
 
691 692
    Prints the list with all the AVPs from memory. This is only a
692 693
    helper/debug function.
... ...
@@ -23,7 +23,7 @@ ALL CHANGES DONE HERE WILL BE LOST IF THE FILE IS REGENERATED
23 23
     <title><varname>db_url</varname> (String)</title>
24 24
     <para>URL to the database containing the data.</para>
25 25
     <para>
26
-      <emphasis>Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.</emphasis>
26
+      <emphasis>Default value is <quote>&defaultrodb;</quote>.</emphasis>
27 27
     </para>
28 28
     <example>
29 29
       <title>Set <varname>db_url</varname> parameter</title>
... ...
@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
4 4
 
5 5
    iptelorg GmbH
6 6
 
7
-   Copyright © 2010 iptelorg GmbH
7
+   Copyright � 2010 iptelorg GmbH
8 8
      __________________________________________________________________
9 9
 
10 10
    1.1. Overview
... ...
@@ -46,7 +46,7 @@ Andrei Pelinescu-Onciul
46 46
    is "custom script counter". The format of the declaration is:
47 47
    [group.]name[( |:)description].
48 48
 
49
-   Example 1.  Create a new script_counter
49
+   Example 1. Create a new script_counter
50 50
 modparam("counters", "script_counter", "foo")  # script.foo
51 51
 modparam("counters", "script_counter", "test.bar")  # test.bar
52 52
 modparam("counters", "script_counter", "baz example counter")  # script.baz
... ...
@@ -59,12 +59,12 @@ modparam("counters", "script_counter", "test.x:another example") # test.x
59 59
 
60 60
    Default: "script".
61 61
 
62
-   Example 2.  Set script_cnt_grp_name in the config file
62
+   Example 2. Set script_cnt_grp_name in the config file
63 63
 modparam("counters", "script_cnt_grp_name", "my_counters")
64 64
 
65 65
 1.3. Functions
66 66
 
67
-1.3.1.  cnt_inc([group.]name)
67
+1.3.1. cnt_inc([group.]name)
68 68
 
69 69
    Increments the counter group.name. The counter must be defined using
70 70
    the script_counter module parameter. If the group name is missing, the
... ...
@@ -82,7 +82,7 @@ route {
82 82
 ...
83 83
 }
84 84
 
85
-1.3.2.  cnt_add([group.]name, number)
85
+1.3.2. cnt_add([group.]name, number)
86 86
 
87 87
    Adds number the counter group.name. The counter must be defined using
88 88
    the script_counter module parameter. If the group name is missing, the
... ...
@@ -97,7 +97,7 @@ route {
97 97
 ...
98 98
 }
99 99
 
100
-1.3.3.  cnt_reset([group.]name)
100
+1.3.3. cnt_reset([group.]name)
101 101
 
102 102
    Resets the counter group.name. The counter must be defined using the
103 103
    script_counter module parameter. If the group name is missing, the
... ...
@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
4 4
 
5 5
    iptelorg GmbH
6 6
 
7
-   Copyright © 2009 iptelorg GmbH
7
+   Copyright � 2009 iptelorg GmbH
8 8
      __________________________________________________________________
9 9
 
10 10
    1.1. Overview
... ...
@@ -5,7 +5,7 @@ Jan Janak
5 5
    FhG FOKUS
6 6
    <jan@iptel.org>
7 7
 
8
-   Copyright © 2004, 2005 FhG FOKUS
8
+   Copyright � 2004, 2005 FhG FOKUS
9 9
      __________________________________________________________________
10 10
 
11 11
    1.1. Overview
... ...
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
-   Copyright © 2006 Voice Sistem SRL
13
+   Copyright � 2006 Voice Sistem SRL
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -109,8 +109,8 @@ modparam("db_mysql", "ping_interval", 600)
109 109
    retries are done from the driver before it gives up.
110 110
 
111 111
    The read timeout parameter is ignored on MySQL driver versions prior to
112
-   “5.1.12”, “5.0.25” and “4.1.22”. The write timeout parameter is ignored
113
-   on versions prior to “5.1.12” and “5.0.25”, the “4.1” release don't
112
+   "5.1.12", "5.0.25" and "4.1.22". The write timeout parameter is ignored
113
+   on versions prior to "5.1.12" and "5.0.25", the "4.1" release don't
114 114
    support it at all.
115 115
 
116 116
    Default value is 2 (6 sec).
... ...
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
-   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
13
+   Copyright � 2010 Daniel-Constantin Mierla (asipto.com)
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -143,7 +143,7 @@ Chapter 1. Admin Guide
143 143
    You can change the value at runtime without restart, globally or per
144 144
    process.
145 145
 
146
-   Default value is “0” (disabled).
146
+   Default value is "0" (disabled).
147 147
 
148 148
    Example 1.1. Set cfgtrace parameter
149 149
 ...
... ...
@@ -155,7 +155,7 @@ modparam("debugger", "cfgtrace", 1)
155 155
    Control whether every line (global) breakpoint is enabled or disabled
156 156
    at startup.
157 157
 
158
-   Default value is “0” (disabled).
158
+   Default value is "0" (disabled).
159 159
 
160 160
    Example 1.2. Set breakpoint parameter
161 161
 ...
... ...
@@ -166,7 +166,7 @@ modparam("debugger", "breakpoint", 1)
166 166
 
167 167
    What log level is to be used to print module-specific messages.
168 168
 
169
-   Default value is “-1” (L_ERR).
169
+   Default value is "-1" (L_ERR).
170 170
 
171 171
    Example 1.3. Set log_level parameter
172 172
 ...
... ...
@@ -177,7 +177,7 @@ modparam("debugger", "log_level", 1)
177 177
 
178 178
    What log facility is to be used to print module-specific messages.
179 179
 
180
-   Default value is “NULL” (default from core).
180
+   Default value is "NULL" (default from core).
181 181
 
182 182
    Example 1.4. Set log_facility parameter
183 183
 ...
... ...
@@ -188,7 +188,7 @@ modparam("debugger", "log_facility", "LOG_DAEMON")
188 188
 
189 189
    String to print before any module-specific messages.
190 190
 
191
-   Default value is “*** cfgtrace:”.
191
+   Default value is "*** cfgtrace:".
192 192
 
193 193
    Example 1.5. Set log_prefix parameter
194 194
 ...
... ...
@@ -200,7 +200,7 @@ modparam("debugger", "log_prefix", "from-debugger-with-love:")
200 200
    Microseconds to sleep before checking for new commands when waiting at
201 201
    breakpoint.
202 202
 
203
-   Default value is “100000” (that is 0.1 sec).
203
+   Default value is "100000" (that is 0.1 sec).
204 204
 
205 205
    Example 1.6. Set step_usleep parameter
206 206
 ...
... ...
@@ -214,7 +214,7 @@ modparam("debugger", "step_usleep", 500000)
214 214
    blocking RPC process forever in case the worker process 'forgets' to
215 215
    write back a reply.
216 216
 
217
-   Default value is “200”.
217
+   Default value is "200".
218 218
 
219 219
    Example 1.7. Set step_loops parameter
220 220
 ...
... ...
@@ -225,7 +225,7 @@ modparam("debugger", "step_loops", 100)
225 225
 
226 226
    4.1. dbg_breakpoint(mode)
227 227
 
228
-4.1.  dbg_breakpoint(mode)
228
+4.1. dbg_breakpoint(mode)
229 229
 
230 230
    Anchor a breakpoint at the current line of the config (the one on which
231 231
    this function is called). The 'mode' specifies whether the breakpoint
... ...
@@ -246,7 +246,7 @@ if($si=="10.0.0.10")
246 246
    5.2. dbg.trace
247 247
    5.3. dbg.bp
248 248
 
249
-5.1.  dbg.ls
249
+5.1. dbg.ls
250 250
 
251 251
    List SIP router processes with info related to interactive debugging.
252 252
 
... ...
@@ -260,7 +260,7 @@ if($si=="10.0.0.10")
260 260
                 dbg.ls
261 261
                 dbg.ls 1234
262 262
 
263
-5.2.  dbg.trace
263
+5.2. dbg.trace
264 264
 
265 265
    Control config running trace.
266 266
 
... ...
@@ -277,7 +277,7 @@ if($si=="10.0.0.10")
277 277
                 dbg.trace off
278 278
                 dbg.trace on 1234
279 279
 
280
-5.3.  dbg.bp
280
+5.3. dbg.bp
281 281
 
282 282
    Control breakpoints and config execution.
283 283
 
... ...
@@ -8,7 +8,7 @@ Otmar Lendl
8 8
 
9 9
    <lendl@nic.at>
10 10
 
11
-   Copyright © 2002, 2003 Juha Heinanen
11
+   Copyright � 2002, 2003 Juha Heinanen
12 12
      __________________________________________________________________
13 13
 
14 14
    Table of Contents
... ...
@@ -74,9 +74,9 @@ Chapter 1. Admin Guide
74 74
    phone number of the form +decimal-digits, where the number of digits is
75 75
    at least 2 and at most 15. Out of this number enum_query forms a domain
76 76
    name, where the digits are in reverse order and separated by dots
77
-   followed by domain suffix that by default is “e164.arpa.”. For example,
77
+   followed by domain suffix that by default is "e164.arpa.". For example,
78 78
    if the user part is +35831234567, the domain name will be
79
-   “7.6.5.4.3.2.1.3.8.5.3.e164.arpa.”. i_enum_query operates in a similar
79
+   "7.6.5.4.3.2.1.3.8.5.3.e164.arpa.". i_enum_query operates in a similar
80 80
    fashion. The only difference is that it adds a label (default "i") to
81 81
    branch off from the default, user-ENUM tree to an infrastructure ENUM
82 82
    tree.
... ...
@@ -143,7 +143,7 @@ Chapter 1. Admin Guide
143 143
    digits of an E164 number. Can be overridden by a parameter to
144 144
    enum_query.
145 145
 
146
-   Default value is “e164.arpa.”
146
+   Default value is "e164.arpa."
147 147
 
148 148
    Example 1.1. Setting domain_suffix module parameter
149 149
 modparam("enum", "domain_suffix", "e1234.arpa.")
... ...
@@ -158,7 +158,7 @@ Note
158 158
    Currently SIP Router does not support tel URIs. This means that at
159 159
    present tel_uri_params is appended as URI parameters to every URI.
160 160
 
161
-   Default value is “”
161
+   Default value is ""
162 162
 
163 163
    Example 1.2. Setting tel_uri_params module parameter
164 164
 modparam("enum", "tel_uri_params", ";npdi")
... ...
@@ -168,7 +168,7 @@ modparam("enum", "tel_uri_params", ";npdi")
168 168
    The domain suffix to be used for i_enum_query() lookups. Can be
169 169
    overridden by a parameter to i_enum_query.
170 170
 
171
-   Default value is “e164.arpa.”
171
+   Default value is "e164.arpa."
172 172
 
173 173
    Example 1.3. Setting i_enum_suffix module parameter
174 174
 modparam("enum", "i_enum_suffix", "e1234.arpa.")
... ...
@@ -178,7 +178,7 @@ modparam("enum", "i_enum_suffix", "e1234.arpa.")
178 178
    This parameter determines which label i_enum_query() will use to branch
179 179
    off to the infrastructure ENUM tree.
180 180
 
181
-   Default value is “"i"”
181
+   Default value is ""i""
182 182
 
183 183
    Example 1.4. Setting brachlabel module parameter
184 184
 modparam("enum", "branchlabel", "i")
... ...
@@ -217,7 +217,7 @@ i.1.e164.arpa.     TYPE65300  \# 14 (
217 217
 ;                               )
218 218
 9.9.9.8.7.6.5.i.4.3.2.1.e164.arpa. IN NAPTR "NAPTR content for  +1 234 5678 999"
219 219
 
220
-   Default value is “cc”
220
+   Default value is "cc"
221 221
 
222 222
    Example 1.7. Setting the bl_algorithm module parameter
223 223
 modparam("enum", "bl_algorithm", "txt")
... ...
@@ -229,10 +229,10 @@ modparam("enum", "bl_algorithm", "txt")
229 229
    4.3. i_enum_query(["suffix"[,"service"]])
230 230
    4.4. is_from_user_enum()
231 231
 
232
-4.1.  enum_query(["suffix"[,"service"]])
232
+4.1. enum_query(["suffix"[,"service"]])
233 233
 
234 234
    The function performs an enum query and rewrites the Request-URI with
235
-   the result of the query. See Section 1, “Overview” for more
235
+   the result of the query. See Section 1, "Overview" for more
236 236
    information.
237 237
 
238 238
    Meaning of the parameters is as follows:
... ...
@@ -265,11 +265,11 @@ enum_query("e164.arpa.","voice");
265 265
 enum_query("e164.arpa.","+sip+voice:sip");
266 266
 ...
267 267
 
268
-4.2.  enum_pv_query("pvar"[,"suffix"[,"service"]])
268
+4.2. enum_pv_query("pvar"[,"suffix"[,"service"]])
269 269
 
270 270
    The function performs an enum query on E.164 number stored in its
271 271
    pseudo variable argument and rewrites the Request-URI with the result
272
-   of the query. See Section 1, “Overview” for more information.
272
+   of the query. See Section 1, "Overview" for more information.
273 273
 
274 274
    Meaning of the parameters is as follows:
275 275
      * pvar - Pseudo variable that holds an E.164 number on which enum
... ...
@@ -301,7 +301,7 @@ enum_pv_query("$avp(i:100)","e164.arpa.","voice");
301 301
 enum_pv_query("$avp(i:100)","e164.arpa.","+sip+voice:sip");
302 302
 ...
303 303
 
304
-4.3.  i_enum_query(["suffix"[,"service"]])
304
+4.3. i_enum_query(["suffix"[,"service"]])
305 305
 
306 306
    The function performs an enum query and rewrites the Request-URI with
307 307
    the result of the query. This the Infrastructure-ENUM version of
... ...
@@ -1,16 +1,16 @@
1 1
 ipops Module
2 2
 
3
-Iñaki Baz Castillo
3
+I�aki Baz Castillo
4 4
 
5 5
    <ibc@aliax.net>
6 6
 
7 7
 Edited by
8 8
 
9
-Iñaki Baz Castillo
9
+I�aki Baz Castillo
10 10
 
11 11
    <ibc@aliax.net>
12 12
 
13
-   Copyright © 2011 Iñaki Baz Castillo
13
+   Copyright � 2011 I�aki Baz Castillo
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -88,7 +88,7 @@ Chapter 1. Admin Guide
88 88
    When using IPv6 in an URI (i.e. a SIP URI) such IP must be written in
89 89
    "IPv6 reference" format (which is the textual representation of the
90 90
    IPv6 enclosed between [ ] symbols). An example is
91
-   “sip:alice@[1080:0:0:0:8:800:200C:417A]”. This module also allows
91
+   "sip:alice@[1080:0:0:0:8:800:200C:417A]". This module also allows
92 92
    comparing a IPv6 with its IPv6 reference representation.
93 93
 
94 94
 2. Dependencies
... ...
@@ -122,7 +122,7 @@ Chapter 1. Admin Guide
122 122
    4.9. is_ip_rfc1918 (ip)
123 123
    4.10. is_in_subnet (ip, subnet)
124 124
 
125
-4.1.  is_ip (ip)
125
+4.1. is_ip (ip)
126 126
 
127 127
    Returns TRUE if the argument is a valid IPv4, IPv6 or IPv6 reference.
128 128
    FALSE otherwise.
... ...
@@ -133,14 +133,14 @@ Chapter 1. Admin Guide
133 133
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
134 134
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
135 135
 
136
-   Example 1.1.  is_ip usage
136
+   Example 1.1. is_ip usage
137 137
 ...
138 138
 if (is_ip($rd)) {
139 139
   xlog("L_INFO", "RURI domain is IP\n");
140 140
 }
141 141
 ...
142 142
 
143
-4.2.  is_pure_ip (ip)
143
+4.2. is_pure_ip (ip)
144 144
 
145 145
    Returns TRUE if the argument is a valid IPv4 or IPv6. FALSE otherwise.
146 146
 
... ...
@@ -150,7 +150,7 @@ if (is_ip($rd)) {
150 150
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
151 151
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
152 152
 
153
-   Example 1.2.  is_pure_ip usage
153
+   Example 1.2. is_pure_ip usage
154 154
 ...
155 155
 $var(ip) = "::1";
156 156
 if (is_pure_ip($var(ip))) {
... ...
@@ -158,7 +158,7 @@ if (is_pure_ip($var(ip))) {
158 158
 }
159 159
 ...
160 160
 
161
-4.3.  is_ipv4 (ip)
161
+4.3. is_ipv4 (ip)
162 162
 
163 163
    Returns TRUE if the argument is a valid IPv4. FALSE otherwise.
164 164
 
... ...
@@ -168,14 +168,14 @@ if (is_pure_ip($var(ip))) {
168 168
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
169 169
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
170 170
 
171
-   Example 1.3.  is_ipv4 usage
171
+   Example 1.3. is_ipv4 usage
172 172
 ...
173 173
 if (is_ipv4("1.2.3.4")) {
174 174
   xlog("L_INFO", "it's IPv4\n");
175 175
 }
176 176
 ...
177 177
 
178
-4.4.  is_ipv6 (ip)
178
+4.4. is_ipv6 (ip)
179 179
 
180 180
    Returns TRUE if the argument is a valid IPv6. FALSE otherwise.
181 181
 
... ...
@@ -185,14 +185,14 @@ if (is_ipv4("1.2.3.4")) {
185 185
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
186 186
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
187 187
 
188
-   Example 1.4.  is_ipv6 usage
188
+   Example 1.4. is_ipv6 usage
189 189
 ...
190 190
 if (is_ipv6("1080:0:0:0:8:800:200C:417A")) {
191 191
   xlog("L_INFO", "it's IPv6\n");
192 192
 }
193 193
 ...
194 194
 
195
-4.5.  is_ipv6_reference (ip)
195
+4.5. is_ipv6_reference (ip)
196 196
 
197 197
    Returns TRUE if the argument is a valid IPv6 reference. FALSE
198 198
    otherwise.
... ...
@@ -203,14 +203,14 @@ if (is_ipv6("1080:0:0:0:8:800:200C:417A")) {
203 203
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
204 204
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
205 205
 
206
-   Example 1.5.  is_ipv6_reference usage
206
+   Example 1.5. is_ipv6_reference usage
207 207
 ...
208 208
 if (is_ipv6_reference("[1080:0:0:0:8:800:200C:417A]")) {
209 209
   xlog("L_INFO", "it's IPv6 reference\n");
210 210
 }
211 211
 ...
212 212
 
213
-4.6.  ip_type (ip)
213
+4.6. ip_type (ip)
214 214
 
215 215
    Returns the type of the given IP.
216 216
 
... ...
@@ -226,7 +226,7 @@ if (is_ipv6_reference("[1080:0:0:0:8:800:200C:417A]")) {
226 226
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
227 227
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
228 228
 
229
-   Example 1.6.  ip_type usage
229
+   Example 1.6. ip_type usage
230 230
 ...
231 231
 ip_type($var(myip));
232 232
 switch($rc) {
... ...
@@ -245,7 +245,7 @@ switch($rc) {
245 245
 }
246 246
 ...
247 247
 
248
-4.7.  compare_ips (ip1, ip2)
248
+4.7. compare_ips (ip1, ip2)
249 249
 
250 250
    Returns TRUE if both IP's are the same. FALSE otherwise. This function
251 251
    also allows comparing an IPv6 against an IPv6 reference.
... ...
@@ -258,7 +258,7 @@ switch($rc) {
258 258
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
259 259
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
260 260
 
261
-   Example 1.7.  compare_ips usage
261
+   Example 1.7. compare_ips usage
262 262
 ...
263 263
 if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
264 264
 7A]")) {
... ...
@@ -266,7 +266,7 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
266 266
 }
267 267
 ...
268 268
 
269
-4.8.  compare_pure_ips (ip1, ip2)
269
+4.8. compare_pure_ips (ip1, ip2)
270 270
 
271 271
    Returns TRUE if both IP's are the same. FALSE otherwise. This function
272 272
    does NOT allow comparing an IPv6 against an IPv6 reference.
... ...
@@ -279,14 +279,14 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41
279 279
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
280 280
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
281 281
 
282
-   Example 1.8.  compare_pure_ips usage
282
+   Example 1.8. compare_pure_ips usage
283 283
 ...
284 284
 if (compare_pure_ips($si, "1080::8:800:200C:417A")) {
285 285
   xlog("L_INFO", "both are the same IP\n");
286 286
 }
287 287
 ...
288 288
 
289
-4.9.  is_ip_rfc1918 (ip)
289
+4.9. is_ip_rfc1918 (ip)
290 290
 
291 291
    Returns TRUE if the argument is a private IPv4 according to RFC 1918.
292 292
    FALSE otherwise.
... ...
@@ -297,14 +297,14 @@ if (compare_pure_ips($si, "1080::8:800:200C:417A")) {
297 297
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
298 298
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
299 299
 
300
-   Example 1.9.  is_ip_rfc1918 usage
300
+   Example 1.9. is_ip_rfc1918 usage
301 301
 ...
302 302
 if (is_ip_rfc1918("10.0.123.123")) {
303 303
   xlog("L_INFO", "it's a private IPv4\n");
304 304
 }
305 305
 ...
306 306
 
307
-4.10.  is_in_subnet (ip, subnet)
307
+4.10. is_in_subnet (ip, subnet)
308 308
 
309 309
    Returns TRUE if the first argument is an IP address within the (CIDR
310 310
    notation) subnet in the second argument. FALSE otherwise.
... ...
@@ -317,7 +317,7 @@ if (is_ip_rfc1918("10.0.123.123")) {
317 317
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
318 318
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
319 319
 
320
-   Example 1.10.  is_in_subnet usage
320
+   Example 1.10. is_in_subnet usage
321 321
 ...
322 322
 if (is_in_subnet("10.0.123.123", "10.0.123.1/24")) {
323 323
   xlog("L_INFO", "it's in the subnet\n");
... ...
@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
4 4
 
5 5
    iptelorg GmbH
6 6
 
7
-   Copyright © 2010 iptelorg GmbH
7
+   Copyright � 2010 iptelorg GmbH
8 8
      __________________________________________________________________
9 9
 
10 10
    1.1. Overview
... ...
@@ -53,10 +53,10 @@ Warning
53 53
 
54 54
    It can be changed also at runtime, via the rpc interface.
55 55
 
56
-   Example 1.  Set check_content in the config file
56
+   Example 1. Set check_content in the config file
57 57
 modparam("malloc_test", "check_content", 1)
58 58
 
59
-   Example 2.  Set check_content at runtime via sercmd
59
+   Example 2. Set check_content at runtime via sercmd
60 60
 $ sercmd cfg.set_now_int malloc_test check_content 1
61 61
 
62 62
 1.3. Functions
... ...
@@ -143,7 +143,7 @@ mem_free();
143 143
    Example 8. mt.mem_rnd_alloc usage
144 144
  $ sercmd mt.mem_rnd_alloc 1 64 10240 k
145 145
 
146
-1.4.5.  mt.mem_test_start min max total min_int max_int total_time [unit]
146
+1.4.5. mt.mem_test_start min max total min_int max_int total_time [unit]
147 147
 
148 148
    Starts a malloc test that will take total_time to execute. Memory
149 149
    allocations will be performed at intervals randomly chosen between
... ...
@@ -11,7 +11,7 @@ Henning Westerholt
11 11
    1&1 Internet AG
12 12
    <henning.westerholt@1und1.de>
13 13
 
14
-   Copyright © 2008 1&1 Internet AG
14
+   Copyright � 2008 1&1 Internet AG
15 15
      __________________________________________________________________
16 16
 
17 17
    Table of Contents
... ...
@@ -44,14 +44,6 @@ Henning Westerholt
44 44
 
45 45
               6.1. Database setup
46 46
 
47
-   2. Module parameter for database access.
48
-
49
-        1. db_url (String)
50
-        2. matrix_table (String)
51
-        3. matrix_first_col (string)
52
-        4. matrix_second_col (string)
53
-        5. matrix_res_col (string)
54
-
55 47
    List of Examples
56 48
 
57 49
    1.1. Set db_url parameter
... ...
@@ -62,11 +54,6 @@ Henning Westerholt
62 54
    1.6. matrix usage
63 55
    1.7. reload_matrix usage
64 56
    1.8. Example database content - matrix table
65
-   2.1. Set db_url parameter
66
-   2.2. Set matrix_table parameter
67
-   2.3. Set matrix_first_col parameter
68
-   2.4. Set matrix_second_col parameter
69
-   2.5. Set matrix_res_col parameter
70 57
 
71 58
 Chapter 1. Admin Guide
72 59
 
... ...
@@ -139,7 +126,7 @@ Chapter 1. Admin Guide
139 126
 
140 127
    The URL for the database connection.
141 128
 
142
-   Default value is “mysql://openserro:openserro@localhost/openser”.
129
+   Default value is "mysql://openserro:openserro@localhost/openser".
143 130
 
144 131
    Example 1.1. Set db_url parameter
145 132
 ...
... ...
@@ -150,7 +137,7 @@ modparam("matrix", "db_url", "mysql://openserro:openserro@localhost/openser")
150 137
 
151 138
    The name of the table containing the matrix data.
152 139
 
153
-   Default value is “matrix”.
140
+   Default value is "matrix".
154 141
 
155 142
    Example 1.2. Set matrix_table parameter
156 143
 ...
... ...
@@ -161,7 +148,7 @@ modparam("matrix", "matrix_table", "matrix")
161 148
 
162 149
    The name of the column containing the first row in the matrix.
163 150
 
164
-   Default value is “first”.
151
+   Default value is "first".
165 152
 
166 153
    Example 1.3. Set matrix_first_col parameter
167 154
 ...
... ...
@@ -172,7 +159,7 @@ modparam("matrix", "matrix_first_col", "first")
172 159
 
173 160
    The name of the column containing the second row in the matrix.
174 161
 
175
-   Default value is “second”.
162
+   Default value is "second".
176 163
 
177 164
    Example 1.4. Set matrix_second_col parameter
178 165
 ...
... ...
@@ -183,7 +170,7 @@ modparam("matrix", "matrix_second_col", "second")
183 170
 
184 171
    The name of the column containing the result ID to be used.
185 172
 
186
-   Default value is “res”.
173
+   Default value is "res".
187 174
 
188 175
    Example 1.5. Set matrix_res_col parameter
189 176
 ...
... ...
@@ -194,7 +181,7 @@ modparam("matrix", "matrix_res_col", "res")
194 181
 
195 182
    4.1. matrix (string first, string second, string dstavp)
196 183
 
197
-4.1.  matrix (string first, string second, string dstavp)
184
+4.1. matrix (string first, string second, string dstavp)
198 185
 
199 186
    Looks up the desired result ID in the matrix for the given column and
200 187
    value and saves the result in dstavp. Returns false if the cell is not
... ...
@@ -213,7 +200,7 @@ cr_route("$avp(route_tree)", "$rd", "$rU", "$rU", "call_id");
213 200
 
214 201
    5.1. reload_matrix
215 202
 
216
-5.1.  reload_matrix
203
+5.1. reload_matrix
217 204
 
218 205
    Reloads the internal matrix representation from the database. This is
219 206
    necessary after entries in the database have been changed.
... ...
@@ -250,61 +237,4 @@ kamctl fifo reload_matrix
250 237
 +---------+--------------+---------+
251 238
 ...
252 239
 
253
-Chapter 2. Module parameter for database access.
254
-
255
-   Table of Contents
256
-
257
-   1. db_url (String)
258
-   2. matrix_table (String)
259
-   3. matrix_first_col (string)
260
-   4. matrix_second_col (string)
261
-   5. matrix_res_col (string)
262
-
263
-1. db_url (String)
264
-
265
-   URL to the database containing the data.
266
-
267
-   Default value is “mysql://openserro:openserro@localhost/openser”.
268
-
269
-   Example 2.1. Set db_url parameter
270
-...
271
-modparam("matrix", "db_url", "dbdriver://username:password@dbhost/dbname")
272
-...
273
-
274
-2. matrix_table (String)
275
-
276
-   Name of the matrix table for the matrix module.
277
-
278
-   Default value is “matrix”.
279
-
280
-   Example 2.2. Set matrix_table parameter
281
-...
282
-modparam("matrix", "matrix_table", "matrix")
283
-...
284
-
285
-3. matrix_first_col (string)
286
-
287
-   The row index in the matrix
288
-
289
-   Example 2.3. Set matrix_first_col parameter
290
-...
291
-modparam("matrix", "matrix_first_col", "first")
292
-...
293
-
294
-4. matrix_second_col (string)
295
-
296
-   The column index in the matrix
297
-
298
-   Example 2.4. Set matrix_second_col parameter
299
-...
300
-modparam("matrix", "matrix_second_col", "second")
301
-...
302
-
303
-5. matrix_res_col (string)
304
-
305
-   The resource contained in the matrix
306
-
307
-   Example 2.5. Set matrix_res_col parameter
308
-...
309
-modparam("matrix", "matrix_res_col", "res")
310
-...
240
+   <xi:include></xi:include>
... ...
@@ -69,14 +69,14 @@
69 69
 	  </para>
70 70
 	  <para>
71 71
 			<emphasis>
72
-				Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.
72
+				Default value is <quote>&defaultrodb;</quote>.
73 73
 		  </emphasis>
74 74
 	  </para>
75 75
 	  <example>
76 76
 		  <title>Set <varname>db_url</varname> parameter</title>
77 77
 		  <programlisting format="linespecific">
78 78
 ...
79
-modparam("matrix", "db_url", "mysql://openserro:openserro@localhost/openser")
79
+modparam("matrix", "db_url", "&defaultrodb;")
80 80
 ...
81 81
 		  </programlisting>
82 82
 	  </example>
... ...
@@ -14,7 +14,7 @@ ALL CHANGES DONE HERE WILL BE LOST IF THE FILE IS REGENERATED
14 14
     <title><varname>db_url</varname> (String)</title>
15 15
     <para>URL to the database containing the data.</para>
16 16
     <para>
17
-      <emphasis>Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.</emphasis>
17
+      <emphasis>Default value is <quote>&defaultrodb;</quote>.</emphasis>
18 18
     </para>
19 19
     <example>
20 20
       <title>Set <varname>db_url</varname> parameter</title>
... ...
@@ -10,7 +10,7 @@ Dan Pascu
10 10
 
11 11
    <dan@ag-projects.com>
12 12
 
13
-   Copyright © 2004 Dan Pascu
13
+   Copyright � 2004 Dan Pascu
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -178,7 +178,7 @@ Chapter 1. Admin Guide
178 178
    mediaproxy is disabled, calls to its functions will have no effect,
179 179
    allowing you to use the same configuration without changes.
180 180
 
181
-   Default value is “0”.
181
+   Default value is "0".
182 182
 
183 183
    Example 1.1. Setting the disable parameter
184 184
 ...
... ...
@@ -190,7 +190,7 @@ modparam("mediaproxy", "disable", 1)
190 190
    It is the path to the filesystem socket where the mediaproxy dispatcher
191 191
    listens for commands from the module.
192 192
 
193
-   Default value is “/var/run/mediaproxy/dispatcher.sock”.
193
+   Default value is "/var/run/mediaproxy/dispatcher.sock".
194 194
 
195 195
    Example 1.2. Setting the mediaproxy_socket parameter
196 196
 ...
... ...
@@ -203,7 +203,7 @@ modparam("mediaproxy", "mediaproxy_socket", "/var/run/mediaproxy/dispatcher.sock
203 203
    How much time (in milliseconds) to wait for an answer from the
204 204
    mediaproxy dispatcher.
205 205
 
206
-   Default value is “500”.
206
+   Default value is "500".
207 207
 
208 208
    Example 1.3. Setting the mediaproxy_timeout parameter
209 209
 ...
... ...
@@ -225,7 +225,7 @@ modparam("mediaproxy", "mediaproxy_timeout", 500)
225 225
    to get the correct NAT IP address from where the SIP signaling
226 226
    originated.
227 227
 
228
-   Default value is “$avp(s:signaling_ip)”.
228
+   Default value is "$avp(s:signaling_ip)".
229 229
 
230 230
    Example 1.4. Setting the signaling_ip_avp parameter
231 231
 ...
... ...
@@ -240,7 +240,7 @@ modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
240 240
    before calling use_media_proxy(), it will be preferred by the
241 241
    dispatcher over the normal selection algorithm.
242 242
 
243
-   Default value is “$avp(s:media_relay)”.
243
+   Default value is "$avp(s:media_relay)".
244 244
 
245 245
    Example 1.5. Setting the media_relay_avp parameter
246 246
 ...
... ...
@@ -255,7 +255,7 @@ modparam("mediaproxy", "media_relay_avp", "$avp(s:media_relay)")
255 255
    selected then a low priority candidate will be added and if
256 256
    'high-priority' is selected a high priority one.
257 257
 
258
-   Default value is “none”.
258
+   Default value is "none".
259 259
 
260 260
    Example 1.6. Setting the ice_candidate parameter
261 261
 ...
... ...
@@ -272,7 +272,7 @@ modparam("mediaproxy", "ice_candidate", "low-priority")
272 272
    tm module to '1', and if the AVP is not set, the default value will be
273 273
    used.
274 274
 
275
-   Default value is “$avp(s:ice_candidate)”.
275
+   Default value is "$avp(s:ice_candidate)".
276 276
 
277 277
    Example 1.7. Setting the ice_candidate_avp parameter
278 278
 ...
... ...
@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
11 11
 
12 12
    <miconda@gmail.com>
13 13
 
14
-   Copyright © 2009 http://www.asipto.com
14
+   Copyright � 2009 http://www.asipto.com
15 15
      __________________________________________________________________
16 16
 
17 17
    Table of Contents
... ...
@@ -112,7 +112,7 @@ modparam("mi_rpc","rpc_url","tcp:localhost:2046")
112 112
 
113 113
    5.1. mi mi_dg mi_fifo mi_xmlrpc
114 114
 
115
-5.1.  mi mi_dg mi_fifo mi_xmlrpc
115
+5.1. mi mi_dg mi_fifo mi_xmlrpc
116 116
 
117 117
    Execute a MI command.
118 118
 
... ...
@@ -10,7 +10,14 @@ Elena-Ramona Modroiu
10 10
 
11 11
    <ramona@asipto.com>
12 12
 
13
-   Copyright © 2010 Elena-Ramona Modroiu (asipto.com)
13
+Edited by
14
+
15
+Alex Balashov
16
+
17
+   Evariste Systems
18
+   <abalashov@evaristesys.com>
19
+
20
+   Copyright � 2010 Elena-Ramona Modroiu (asipto.com)
14 21
      __________________________________________________________________
15 22
 
16 23
    Table of Contents
... ...
@@ -32,6 +39,7 @@ Elena-Ramona Modroiu
32 39
               4.1. mq_add(queue, key, value)
33 40
               4.2. mq_fetch(queue)
34 41
               4.3. mq_pv_free(queue)
42
+              4.4. mq_size(queue)
35 43
 
36 44
    List of Examples
37 45
 
... ...
@@ -39,6 +47,7 @@ Elena-Ramona Modroiu
39 47
    1.2. mq_add usage
40 48
    1.3. mq_fetch usage
41 49
    1.4. mq_pv_free usage
50
+   1.5. mq_size usage
42 51
 
43 52
 Chapter 1. Admin Guide
44 53
 
... ...
@@ -59,6 +68,7 @@ Chapter 1. Admin Guide
59 68
         4.1. mq_add(queue, key, value)
60 69
         4.2. mq_fetch(queue)
61 70
         4.3. mq_pv_free(queue)
71
+        4.4. mq_size(queue)
62 72
 
63 73
 1. Overview
64 74
 
... ...
@@ -94,7 +104,7 @@ Chapter 1. Admin Guide
94 104
 
95 105
    Definition of memory queue
96 106
 
97
-   Default value is “none”.
107
+   Default value is "none".
98 108
 
99 109
    Value must be a list of parameters: attr=value;... The attribute 'name'
100 110
    is mandatory, defining the name of the queue. Optional attribute 'size'
... ...
@@ -115,8 +125,9 @@ modparam("mqueue", "mqueue", "name=qaz")
115 125
    4.1. mq_add(queue, key, value)
116 126
    4.2. mq_fetch(queue)
117 127
    4.3. mq_pv_free(queue)
128
+   4.4. mq_size(queue)
118 129
 
119
-4.1.  mq_add(queue, key, value)
130
+4.1. mq_add(queue, key, value)
120 131
 
121 132
    Add a new item (key, value) in the queue. If max size of queue is
122 133
    exceeded, the oldest one is removed.
... ...
@@ -126,7 +137,7 @@ modparam("mqueue", "mqueue", "name=qaz")
126 137
 mq_add("myq", "$rU", "call from $fU");
127 138
 ...
128 139
 
129
-4.2.  mq_fetch(queue)
140
+4.2. mq_fetch(queue)
130 141
 
131 142
    Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo
132 143
    variables.
... ...
@@ -142,7 +153,7 @@ while(mq_fetch("myq"))
142 153
 }
143 154
 ...
144 155
 
145
-4.3.  mq_pv_free(queue)
156
+4.3. mq_pv_free(queue)
146 157
 
147 158
    Free the item fetched in pseudo-variables. It is optional, a new fetch
148 159
    frees the old values.
... ...
@@ -151,3 +162,13 @@ while(mq_fetch("myq"))
151 162
 ...
152 163
 mq_pv_free("myq");
153 164
 ...
165
+
166
+4.4. mq_size(queue)
167
+
168
+   Returns the current number of elements in the mqueue.
169
+
170
+   Example 1.5. mq_size usage
171
+...
172
+$var(q_size) = mq_size("queue");
173
+xlog("L_INFO", "Size of queue is: $var(q_size)\n");
174
+...
... ...
@@ -16,7 +16,7 @@ Alex Balashov
16 16
 
17 17
    <abalashov@evaristesys.com>
18 18
 
19
-   Copyright © 2012 asipto.com
19
+   Copyright � 2012 asipto.com
20 20
      __________________________________________________________________
21 21
 
22 22
    Table of Contents
... ...
@@ -162,7 +162,7 @@ modparam("msrp", "sipmsg", 1)
162 162
    4.6. msrp_relay_flags(flags)
163 163
    4.7. msrp_reply_flags(flags)
164 164
 
165
-4.1.  msrp_relay()
165
+4.1. msrp_relay()
166 166
 
167 167
    Relay MSRP frame according to the To-Path. This function has to be
168 168
    executed for each MSRP request or reply that has to be forwarded. Note
... ...
@@ -178,7 +178,7 @@ event_route[msrp:frame-in] {
178 178
 }
179 179
 ...
180 180
 
181
-4.2.  msrp_reply(code, text [, hdrs])
181
+4.2. msrp_reply(code, text [, hdrs])
182 182
 
183 183
    Send a reply for the current MSRP request, adding optional headers.
184 184
 
... ...
@@ -193,7 +193,7 @@ event_route[msrp:frame-in] {
193 193
 }
194 194
 ...
195 195
 
196
-4.3.  msrp_is_request()
196
+4.3. msrp_is_request()
197 197
 
198 198
    Return true if the MSRP frame is a request.
199 199
 
... ...
@@ -210,7 +210,7 @@ event_route[msrp:frame-in] {
210 210
 }
211 211
 ...
212 212
 
213
-4.4.  msrp_is_reply()
213
+4.4. msrp_is_reply()
214 214
 
215 215
    Return true if the MSRP frame is a reply.
216 216
 
... ...
@@ -227,7 +227,7 @@ event_route[msrp:frame-in] {
227 227
 }
228 228
 ...
229 229
 
230
-4.5.  msrp_set_dst(addr, sock)
230
+4.5. msrp_set_dst(addr, sock)
231 231
 
232 232
    Set destination attributes: addr - target address as MSRP URI; sock -
233 233
    local socket to be used (format 'proto:ip:port').
... ...
@@ -245,7 +245,7 @@ event_route[msrp:frame-in] {
245 245
 }
246 246
 ...
247 247
 
248
-4.6.  msrp_relay_flags(flags)
248
+4.6. msrp_relay_flags(flags)
249 249
 
250 250
    Set transport layer sending flags for forwarding current MSRP frame;
251 251
    flags - a bitmask of flags - 1 (don't create a new connection), 2
... ...
@@ -264,7 +264,7 @@ event_route[msrp:frame-in] {
264 264
 }
265 265
 ...
266 266
 
267
-4.7.  msrp_reply_flags(flags)
267
+4.7. msrp_reply_flags(flags)
268 268
 
269 269
    Set transport layer sending flags for replies to the current MSRP
270 270
    frame; flags - a bitmask of flags - 1 (don't create a new connection),
... ...
@@ -20,9 +20,9 @@ Juha Heinanen
20 20
 
21 21
    <jh@tutpro.com>
22 22
 
23
-   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
23
+   Copyright � 2010 Daniel-Constantin Mierla (asipto.com)
24 24
 
25
-   Copyright © 2011 Juha Heinanen
25
+   Copyright � 2011 Juha Heinanen
26 26
      __________________________________________________________________
27 27
 
28 28
    Table of Contents
... ...
@@ -155,7 +155,7 @@ Chapter 1. Admin Guide
155 155
 
156 156
    URL of the database server to be used.
157 157
 
158
-   Default value is “mysql://openser:openserrw@localhost/openser”.
158
+   Default value is "mysql://openser:openserrw@localhost/openser".
159 159
 
160 160
    Example 1.1. Set db_url parameter
161 161
 ...
... ...
@@ -167,7 +167,7 @@ modparam("mtree", "db_url", "dbdriver://username:password@dbhost/dbname")
167 167
    Name of DB table where data for trees is store. It is ignored if a
168 168
    'mtree' parameter is defined.
169 169
 
170
-   Default value is “mtrees”.
170
+   Default value is "mtrees".
171 171
 
172 172
    Example 1.2. Set db_table parameter
173 173
 ...
... ...
@@ -178,7 +178,7 @@ modparam("mtree", "db_table", "mymtrees")
178 178
 
179 179
    Definition of memory tree
180 180
 
181
-   Default value is “none”.
181
+   Default value is "none".
182 182
 
183 183
    Example 1.3. Set mtree parameter
184 184
 ...
... ...
@@ -189,7 +189,7 @@ modparam("mtree", "mtree", "name=mytable;dbtable=routes;type=0;")
189 189
 
190 190
    Name of 'tname' column.
191 191
 
192
-   Default value is “tname”.
192
+   Default value is "tname".
193 193
 
194 194
    Example 1.4. Set tname_column parameter
195 195
 ...
... ...
@@ -200,7 +200,7 @@ modparam("mtree", "tname_column", "name")
200 200
 
201 201
    Name of 'tprefix' column.
202 202
 
203
-   Default value is “tprefix”.
203
+   Default value is "tprefix".
204 204
 
205 205
    Example 1.5. Set tprefix_column parameter
206 206
 ...
... ...
@@ -211,7 +211,7 @@ modparam("mtree", "tprefix_column", "prefix")
211 211
 
212 212
    Name of 'tvalue' column.
213 213
 
214
-   Default value is “tvalue”.
214
+   Default value is "tvalue".
215 215
 
216 216
    Example 1.6. Set tvalue_column parameter
217 217
 ...
... ...
@@ -233,7 +233,7 @@ modparam("mtree", "fetch_rows", 4000)
233 233
 
234 234
    The list with characters allowed in prefix.
235 235
 
236
-   Default value is “0123456789”.
236
+   Default value is "0123456789".
237 237
 
238 238
    Example 1.8. Set char_list parameter
239 239
 ...
... ...
@@ -245,7 +245,7 @@ modparam("mtree", "char_list", "0123456789*+")
245 245
    The PV spec where to store the matched value. It can be any writtable
246 246
    PV.
247 247
 
248
-   Default value is “$avp(s:tvalue)”.
248
+   Default value is "$avp(s:tvalue)".
249 249
 
250 250
    Example 1.9. Set pv_value parameter
251 251
 ...
... ...
@@ -257,7 +257,7 @@ modparam("mtree", "pv_value", "$var(mtval)")
257 257
    The PV spec where to store the matched values when mtree is of type 0
258 258
    or 2 and mode of mt_match() call has value 2. It can be any AVP.
259 259
 
260
-   Default value is “$avp(s:tvalues)”.
260
+   Default value is "$avp(s:tvalues)".
261 261
 
262 262
    Example 1.10. Set pv_values parameter
263 263
 ...
... ...
@@ -302,7 +302,7 @@ modparam("mtree", "mt_allow_duplicates", 1)
302 302
 
303 303
    4.1. mt_match(mtree, pv, mode)
304 304
 
305
-4.1.  mt_match(mtree, pv, mode)
305
+4.1. mt_match(mtree, pv, mode)
306 306
 
307 307
    Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value
308 308
    of 'mode' is NOT 2, sets a value of longest matching prefix to pseudo
... ...
@@ -323,7 +323,7 @@ mt_match("mytree", "$rU", "0");
323 323
    5.2. mt_reload
324 324
    5.3. mt_summary
325 325
 
326
-5.1.  mt_list
326
+5.1. mt_list
327 327
 
328 328
    List content of a tree.
329 329
 
... ...
@@ -337,7 +337,7 @@ mt_match("mytree", "$rU", "0");
337 337
                 _mtname_
338 338
                 _empty_line_
339 339
 
340
-5.2.  mt_reload
340
+5.2. mt_reload
341 341
 
342 342
    Reload mtree from database.
343 343
 
... ...
@@ -352,7 +352,7 @@ mt_match("mytree", "$rU", "0");
352 352
                 _mtname_
353 353
                 _empty_line_
354 354
 
355
-5.3.  mt_summary
355
+5.3. mt_summary
356 356
 
357 357
    List usage summary for all trees.
358 358
 
... ...
@@ -11,7 +11,7 @@ Henning Westerholt
11 11
    1&1 Internet AG
12 12
    <henning.westerholt@1und1.de>
13 13
 
14
-   Copyright © 2009 1&1 Internet AG
14
+   Copyright � 2009 1&1 Internet AG
15 15
      __________________________________________________________________
16 16
 
17 17
    Table of Contents
... ...
@@ -113,7 +113,7 @@ Chapter 1. Admin Guide
113 113
 
114 114
    This is the timeout in milliseconds for the pdb_query function.
115 115
 
116
-   Default value is “50”.
116
+   Default value is "50".
117 117
 
118 118
    Example 1.1. Set timeout parameter
119 119
 ...
... ...
@@ -135,7 +135,7 @@ modparam("pdb", "server", "localhost:10001,host.name:10001,192.168.1.7:10002")
135 135
 
136 136
    4.1. pdb_query (string query, string dstavp)
137 137
 
138
-4.1.  pdb_query (string query, string dstavp)
138
+4.1. pdb_query (string query, string dstavp)
139 139
 
140 140
    Sends the query string to all configured servers and stores the answer
141 141
    in dstavp. If it takes more than the configured timeout, false is
... ...
@@ -159,7 +159,7 @@ cr_route("$avp(i:82)", "$rd", "$rU", "$rU", "call_id");
159 159
    5.2. pdb_activate
160 160
    5.3. pdb_deactivate
161 161
 
162
-5.1.  pdb_status
162
+5.1. pdb_status
163 163
 
164 164
    Prints the status of the module. This can either be "active" or
165 165
    "deactivated".
... ...
@@ -169,7 +169,7 @@ cr_route("$avp(i:82)", "$rd", "$rU", "$rU", "call_id");
169 169
 kamctl fifo pdb_status
170 170
 ...
171 171
 
172
-5.2.  pdb_activate
172
+5.2. pdb_activate
173 173
 
174 174
    Activates the module. This is the default after loading the module.
175 175
 
... ...
@@ -178,7 +178,7 @@ kamctl fifo pdb_status
178 178
 kamctl fifo pdb_activate
179 179
 ...
180 180
 
181
-5.3.  pdb_deactivate
181
+5.3. pdb_deactivate
182 182
 
183 183
    Deactivates the module. No more queries are performed until it is
184 184
    activated again. As long as the module is deactivated, the pdb_query
... ...
@@ -23,7 +23,7 @@ Daniel-Constantin Mierla
23 23
               2.1. Kamailio Modules
24 24
               2.2. External Libraries or Applications
25 25
 
26
-        3. Exported Parameters
26
+        3. Parameters
27 27
 
28 28
               3.1. db_url (string)
29 29
               3.2. plp_table_name (string)
... ...
@@ -34,12 +34,12 @@ Daniel-Constantin Mierla
34 34
               3.7. reply_code (integer)
35 35
               3.8. reply_reason (string)
36 36
 
37
-        4. Exported Functions
37
+        4. Functions
38 38
 
39 39
               4.1. pl_check(name)
40 40
               4.2. pl_drop([ [min ], max ])
41 41
 
42
-        5. Exported MI Functions
42
+        5. MI Commands
43 43
 
44 44
               5.1. pl_stats
45 45
               5.2. pl_set_pipe
... ...
@@ -73,7 +73,7 @@ Chapter 1. Admin Guide
73 73
         2.1. Kamailio Modules
74 74
         2.2. External Libraries or Applications
75 75
 
76
-   3. Exported Parameters
76
+   3. Parameters
77 77
 
78 78
         3.1. db_url (string)
79 79
         3.2. plp_table_name (string)
... ...
@@ -84,12 +84,12 @@ Chapter 1. Admin Guide
84 84
         3.7. reply_code (integer)
85 85
         3.8. reply_reason (string)
86 86
 
87
-   4. Exported Functions
87
+   4. Functions
88 88
 
89 89
         4.1. pl_check(name)
90 90
         4.2. pl_drop([ [min ], max ])
91 91
 
92
-   5. Exported MI Functions
92
+   5. MI Commands
93 93
 
94 94
         5.1. pl_stats
95 95
         5.2. pl_set_pipe
... ...
@@ -130,7 +130,7 @@ Chapter 1. Admin Guide
130 130
    running Kamailio with this module loaded:
131 131
      * None.
132 132
 
133
-3. Exported Parameters
133
+3. Parameters
134 134
 
135 135
    3.1. db_url (string)
136 136
    3.2. plp_table_name (string)
... ...
@@ -244,7 +244,7 @@ modparam("ratelimit", "reply_reason", "Limiting")
244 244
    Example 1.10.  Set reply_reason parameter at runtime
245 245
 sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
246 246