Browse code

modules: readme files regenerated - registrar ... [skip ci]

Kamailio Dev authored on 04/02/2020 15:31:15
Showing 1 changed files
... ...
@@ -49,34 +49,35 @@ Bogdan-Andre Iancu
49 49
               3.2. default_expires_range (integer)
50 50
               3.3. expires_range (integer)
51 51
               3.4. min_expires (integer)
52
-              3.5. max_expires (integer)
53
-              3.6. default_q (integer)
54
-              3.7. realm_prefix (string)
55
-              3.8. append_branches (integer)
56
-              3.9. aor_avp (str)
57
-              3.10. case_sensitive (integer)
58
-              3.11. received_avp (str)
59
-              3.12. received_param (string)
60
-              3.13. max_contacts (integer)
61
-              3.14. retry_after (integer)
62
-              3.15. sock_flag (integer)
63
-              3.16. sock_hdr_name (string)
64
-              3.17. method_filtering (integer)
65
-              3.18. use_path (integer)
66
-              3.19. path_mode (integer)
67
-              3.20. path_use_received (integer)
68
-              3.21. path_check_local (integer)
69
-              3.22. reg_callid_avp (string)
70
-              3.23. xavp_cfg (string)
71
-              3.24. xavp_rcd (string)
72
-              3.25. xavp_rcd_mask (int)
73
-              3.26. gruu_enabled (integer)
74
-              3.27. outbound_mode (integer)
75
-              3.28. regid_mode (integer)
76
-              3.29. flow_timer (integer)
77
-              3.30. contact_max_size (integer)
78
-              3.31. event_callback (str)
79
-              3.32. lookup_filter_mode (int)
52
+              3.5. min_expires_mode (integer)
53
+              3.6. max_expires (integer)
54
+              3.7. default_q (integer)
55
+              3.8. realm_prefix (string)
56
+              3.9. append_branches (integer)
57
+              3.10. aor_avp (str)
58
+              3.11. case_sensitive (integer)
59
+              3.12. received_avp (str)
60
+              3.13. received_param (string)
61
+              3.14. max_contacts (integer)
62
+              3.15. retry_after (integer)
63
+              3.16. sock_flag (integer)
64
+              3.17. sock_hdr_name (string)
65
+              3.18. method_filtering (integer)
66
+              3.19. use_path (integer)
67
+              3.20. path_mode (integer)
68
+              3.21. path_use_received (integer)
69
+              3.22. path_check_local (integer)
70
+              3.23. reg_callid_avp (string)
71
+              3.24. xavp_cfg (string)
72
+              3.25. xavp_rcd (string)
73
+              3.26. xavp_rcd_mask (int)
74
+              3.27. gruu_enabled (integer)
75
+              3.28. outbound_mode (integer)
76
+              3.29. regid_mode (integer)
77
+              3.30. flow_timer (integer)
78
+              3.31. contact_max_size (integer)
79
+              3.32. event_callback (str)
80
+              3.33. lookup_filter_mode (int)
80 81
 
81 82
         4. Functions
82 83
 
... ...
@@ -116,44 +117,45 @@ Bogdan-Andre Iancu
116 117
    1.2. Set default_expires_range parameter
117 118
    1.3. Set expires_range parameter
118 119
    1.4. Set min_expires parameter
119
-   1.5. Set max_expires parameter
120
-   1.6. Set default_q parameter
121
-   1.7. Set realm_prefix parameter
122
-   1.8. Set append_branches parameter
123
-   1.9. Set case_sensitive parameter
124
-   1.10. Set received_avp parameter
125
-   1.11. Set received_param parameter
126
-   1.12. Set max_contacts parameter
127
-   1.13. Set retry_after parameter
128
-   1.14. Set sock_flag parameter
129
-   1.15. Set sock_hdr_name parameter
130
-   1.16. Set method_filtering parameter
131
-   1.17. Set use_path parameter
132
-   1.18. Set path_mode parameter
133
-   1.19. Set path_use_received parameter
134
-   1.20. Set path_check_local parameter
135
-   1.21. Set reg_callid_avp parameter
136
-   1.22. Set xavp_cfg parameter
137
-   1.23. Set xavp_rcd parameter
138
-   1.24. Set xavp_rcd_mask parameter
139
-   1.25. Set gruu_enabled parameter
140
-   1.26. Set outbound_mode parameter
141
-   1.27. Set regid_mode parameter
142
-   1.28. Set flow_timer parameter
143
-   1.29. Set contact_max_size parameter
144
-   1.30. Set event_callback parameter
145
-   1.31. Set xavp_cfg parameter
146
-   1.32. save usage
147
-   1.33. lookup usage
148
-   1.34. lookup_branches usage
149
-   1.35. registered usage
150
-   1.36. add_sock_hdr usage
151
-   1.37. unregister usage
152
-   1.38. reg_fetch_contacts usage
153
-   1.39. reg_free_contacts usage
154
-   1.40. reg_send_reply usage
155
-   1.41. event_route[usrloc:contact-expired] usage
156
-   1.42. $ulc(name) usage
120
+   1.5. Set min_expires_mode parameter
121
+   1.6. Set max_expires parameter
122
+   1.7. Set default_q parameter
123
+   1.8. Set realm_prefix parameter
124
+   1.9. Set append_branches parameter
125
+   1.10. Set case_sensitive parameter
126
+   1.11. Set received_avp parameter
127
+   1.12. Set received_param parameter
128
+   1.13. Set max_contacts parameter
129
+   1.14. Set retry_after parameter
130
+   1.15. Set sock_flag parameter
131
+   1.16. Set sock_hdr_name parameter
132
+   1.17. Set method_filtering parameter
133
+   1.18. Set use_path parameter
134
+   1.19. Set path_mode parameter
135
+   1.20. Set path_use_received parameter
136
+   1.21. Set path_check_local parameter
137
+   1.22. Set reg_callid_avp parameter
138
+   1.23. Set xavp_cfg parameter
139
+   1.24. Set xavp_rcd parameter
140
+   1.25. Set xavp_rcd_mask parameter
141
+   1.26. Set gruu_enabled parameter
142
+   1.27. Set outbound_mode parameter
143
+   1.28. Set regid_mode parameter
144
+   1.29. Set flow_timer parameter
145
+   1.30. Set contact_max_size parameter
146
+   1.31. Set event_callback parameter
147
+   1.32. Set xavp_cfg parameter
148
+   1.33. save usage
149
+   1.34. lookup usage
150
+   1.35. lookup_branches usage
151
+   1.36. registered usage
152
+   1.37. add_sock_hdr usage
153
+   1.38. unregister usage
154
+   1.39. reg_fetch_contacts usage
155
+   1.40. reg_free_contacts usage
156
+   1.41. reg_send_reply usage
157
+   1.42. event_route[usrloc:contact-expired] usage
158
+   1.43. $ulc(name) usage
157 159
 
158 160
 Chapter 1. Admin Guide
159 161
 
... ...
@@ -175,34 +177,35 @@ Chapter 1. Admin Guide
175 177
         3.2. default_expires_range (integer)
176 178
         3.3. expires_range (integer)
177 179
         3.4. min_expires (integer)
178
-        3.5. max_expires (integer)
179
-        3.6. default_q (integer)
180
-        3.7. realm_prefix (string)
181
-        3.8. append_branches (integer)
182
-        3.9. aor_avp (str)
183
-        3.10. case_sensitive (integer)
184
-        3.11. received_avp (str)
185
-        3.12. received_param (string)
186
-        3.13. max_contacts (integer)
187
-        3.14. retry_after (integer)
188
-        3.15. sock_flag (integer)
189
-        3.16. sock_hdr_name (string)
190
-        3.17. method_filtering (integer)
191
-        3.18. use_path (integer)
192
-        3.19. path_mode (integer)
193
-        3.20. path_use_received (integer)
194
-        3.21. path_check_local (integer)
195
-        3.22. reg_callid_avp (string)
196
-        3.23. xavp_cfg (string)
197
-        3.24. xavp_rcd (string)
198
-        3.25. xavp_rcd_mask (int)
199
-        3.26. gruu_enabled (integer)
200
-        3.27. outbound_mode (integer)
201
-        3.28. regid_mode (integer)
202
-        3.29. flow_timer (integer)
203
-        3.30. contact_max_size (integer)
204
-        3.31. event_callback (str)
205
-        3.32. lookup_filter_mode (int)
180
+        3.5. min_expires_mode (integer)
181
+        3.6. max_expires (integer)
182
+        3.7. default_q (integer)
183
+        3.8. realm_prefix (string)
184
+        3.9. append_branches (integer)
185
+        3.10. aor_avp (str)
186
+        3.11. case_sensitive (integer)
187
+        3.12. received_avp (str)
188
+        3.13. received_param (string)
189
+        3.14. max_contacts (integer)
190
+        3.15. retry_after (integer)
191
+        3.16. sock_flag (integer)
192
+        3.17. sock_hdr_name (string)
193
+        3.18. method_filtering (integer)
194
+        3.19. use_path (integer)
195
+        3.20. path_mode (integer)
196
+        3.21. path_use_received (integer)
197
+        3.22. path_check_local (integer)
198
+        3.23. reg_callid_avp (string)
199
+        3.24. xavp_cfg (string)
200
+        3.25. xavp_rcd (string)
201
+        3.26. xavp_rcd_mask (int)
202
+        3.27. gruu_enabled (integer)
203
+        3.28. outbound_mode (integer)
204
+        3.29. regid_mode (integer)
205
+        3.30. flow_timer (integer)
206
+        3.31. contact_max_size (integer)
207
+        3.32. event_callback (str)
208
+        3.33. lookup_filter_mode (int)
206 209
 
207 210
    4. Functions
208 211
 
... ...
@@ -302,34 +305,35 @@ Chapter 1. Admin Guide
302 305
    3.2. default_expires_range (integer)
303 306
    3.3. expires_range (integer)
304 307
    3.4. min_expires (integer)
305
-   3.5. max_expires (integer)
306
-   3.6. default_q (integer)
307
-   3.7. realm_prefix (string)
308
-   3.8. append_branches (integer)
309
-   3.9. aor_avp (str)
310
-   3.10. case_sensitive (integer)
311
-   3.11. received_avp (str)
312
-   3.12. received_param (string)
313
-   3.13. max_contacts (integer)
314
-   3.14. retry_after (integer)
315
-   3.15. sock_flag (integer)
316
-   3.16. sock_hdr_name (string)
317
-   3.17. method_filtering (integer)
318
-   3.18. use_path (integer)
319
-   3.19. path_mode (integer)
320
-   3.20. path_use_received (integer)
321
-   3.21. path_check_local (integer)
322
-   3.22. reg_callid_avp (string)
323
-   3.23. xavp_cfg (string)
324
-   3.24. xavp_rcd (string)
325
-   3.25. xavp_rcd_mask (int)
326
-   3.26. gruu_enabled (integer)
327
-   3.27. outbound_mode (integer)
328
-   3.28. regid_mode (integer)
329
-   3.29. flow_timer (integer)
330
-   3.30. contact_max_size (integer)
331
-   3.31. event_callback (str)
332
-   3.32. lookup_filter_mode (int)
308
+   3.5. min_expires_mode (integer)
309
+   3.6. max_expires (integer)
310
+   3.7. default_q (integer)
311
+   3.8. realm_prefix (string)
312
+   3.9. append_branches (integer)
313
+   3.10. aor_avp (str)
314
+   3.11. case_sensitive (integer)
315
+   3.12. received_avp (str)
316
+   3.13. received_param (string)
317
+   3.14. max_contacts (integer)
318
+   3.15. retry_after (integer)
319
+   3.16. sock_flag (integer)
320
+   3.17. sock_hdr_name (string)
321
+   3.18. method_filtering (integer)
322
+   3.19. use_path (integer)
323
+   3.20. path_mode (integer)
324
+   3.21. path_use_received (integer)
325
+   3.22. path_check_local (integer)
326
+   3.23. reg_callid_avp (string)
327
+   3.24. xavp_cfg (string)
328
+   3.25. xavp_rcd (string)
329
+   3.26. xavp_rcd_mask (int)
330
+   3.27. gruu_enabled (integer)
331
+   3.28. outbound_mode (integer)
332
+   3.29. regid_mode (integer)
333
+   3.30. flow_timer (integer)
334
+   3.31. contact_max_size (integer)
335
+   3.32. event_callback (str)
336
+   3.33. lookup_filter_mode (int)
333 337
 
334 338
 3.1. default_expires (integer)
335 339
 
... ...
@@ -382,9 +386,9 @@ res]
382 386
 3.4. min_expires (integer)
383 387
 
384 388
    The minimum expires value of a “Contact”. Values lower than this
385
-   minimum will be automatically set to the minimum. Value 0 disables the
386
-   checking. This parameter can be modified via the Kamailio config
387
-   framework.
389
+   minimum will be either set to the minimum or 423 response is sent back.
390
+   Value 0 disables the checking. This parameter can be modified via the
391
+   Kamailio config framework.
388 392
 
389 393
    Default value is 60.
390 394
 
... ...
@@ -393,7 +397,20 @@ res]
393 397
 modparam("registrar", "min_expires", 60)
394 398
 ...
395 399
 
396
-3.5. max_expires (integer)
400
+3.5. min_expires_mode (integer)
401
+
402
+   Control what to do when expires value in REGISTER request is lower than
403
+   min_expires parameter. If set to 0, expires is set to min_expires. If
404
+   set to 1, then 423 Interval Too Brief is sent back.
405
+
406
+   Default value is 0.
407
+
408
+   Example 1.5. Set min_expires_mode parameter
409
+...
410
+modparam("registrar", "min_expires_mode", 1)
411
+...
412
+
413
+3.6. max_expires (integer)
397 414
 
398 415
    The maximum accepted expires value of a “Contact”, values higher than
399 416
    this maximum will be automatically set to the maximum. Value 0 disables
... ...
@@ -402,12 +419,12 @@ modparam("registrar", "min_expires", 60)
402 419
 
403 420
    Default value is 0.
404 421
 
405
-   Example 1.5. Set max_expires parameter
422
+   Example 1.6. Set max_expires parameter
406 423
 ...
407 424
 modparam("registrar", "max_expires", 120)
408 425
 ...
409 426
 
410
-3.6. default_q (integer)
427
+3.7. default_q (integer)
411 428
 
412 429
    The parameter represents default “q” value for new contacts. Because
413 430
    Kamailio doesn't support float parameter types, the value in the
... ...
@@ -417,12 +434,12 @@ modparam("registrar", "max_expires", 120)
417 434
 
418 435
    Default value is 0.
419 436
 
420
-   Example 1.6. Set default_q parameter
437
+   Example 1.7. Set default_q parameter
421 438
 ...
422 439
 modparam("registrar", "default_q", 1000)
423 440
 ...
424 441
 
425
-3.7. realm_prefix (string)
442
+3.8. realm_prefix (string)
426 443
 
427 444
    Prefix to be automatically stripped from realm. As an alternative to
428 445
    SRV records (not all SIP clients support SRV lookup), a subdomain of
... ...
@@ -434,12 +451,12 @@ modparam("registrar", "default_q", 1000)
434 451
 
435 452
    Default value is NULL (none).
436 453
 
437
-   Example 1.7. Set realm_prefix parameter
454
+   Example 1.8. Set realm_prefix parameter
438 455
 ...
439 456
 modparam("registrar", "realm_prefix", "sip.")
440 457
 ...
441 458
 
442
-3.8. append_branches (integer)
459
+3.9. append_branches (integer)
443 460
 
444 461
    The parameter controls how lookup function processes multiple contacts.
445 462
    If there are multiple contacts for the given username in usrloc and
... ...
@@ -452,17 +469,17 @@ modparam("registrar", "realm_prefix", "sip.")
452 469
 
453 470
    Default value is 1.
454 471
 
455
-   Example 1.8. Set append_branches parameter
472
+   Example 1.9. Set append_branches parameter
456 473
 ...
457 474
 modparam("registrar", "append_branches", 0)
458 475
 ...
459 476
 
460
-3.9. aor_avp (str)
477
+3.10. aor_avp (str)
461 478
 
462 479
    This module parameter has been removed. Use the 'uri' parameter from
463 480
    functions (e.g., save, lookup, registered).
464 481
 
465
-3.10. case_sensitive (integer)
482
+3.11. case_sensitive (integer)
466 483
 
467 484
    If set to 1 then AOR comparison and also storing will be case
468 485
    sensitive, if set to 0 then AOR comparison and storing will be case
... ...
@@ -471,12 +488,12 @@ modparam("registrar", "append_branches", 0)
471 488
 
472 489
    Default value is 0.
473 490
 
474
-   Example 1.9. Set case_sensitive parameter
491
+   Example 1.10. Set case_sensitive parameter
475 492
 ...
476 493
 modparam("registrar", "case_sensitive", 1)
477 494
 ...
478 495
 
479
-3.11. received_avp (str)
496
+3.12. received_avp (str)
480 497
 
481 498
    Registrar will store the value of the AVP configured by this parameter
482 499
    in the received column in the user location database. It will leave the
... ...
@@ -491,12 +508,12 @@ Note
491 508
 
492 509
    Default value is "NULL" (disabled).
493 510
 
494
-   Example 1.10. Set received_avp parameter
511
+   Example 1.11. Set received_avp parameter
495 512
 ...
496 513
 modparam("registrar", "received_avp", "$avp(s:rcv)")
497 514
 ...
498 515
 
499
-3.12. received_param (string)
516
+3.13. received_param (string)
500 517
 
501 518
    The name of the parameter that will be appended to Contact URI's of 200
502 519
    OK when the received URI was set by the “nathelper” module. If the
... ...
@@ -504,12 +521,12 @@ modparam("registrar", "received_avp", "$avp(s:rcv)")
504 521
 
505 522
    Default value is "received".
506 523
 
507
-   Example 1.11. Set received_param parameter
524
+   Example 1.12. Set received_param parameter
508 525
 ...
509 526
 modparam("registrar", "received_param", "rcv")
510 527
 ...
511 528
 
512
-3.13. max_contacts (integer)
529
+3.14. max_contacts (integer)
513 530
 
514 531
    The parameter can be used to limit the number of contacts per AOR
515 532
    (Address of Record) in the user location database. If the maximum
... ...
@@ -521,13 +538,13 @@ modparam("registrar", "received_param", "rcv")
521 538
 
522 539
    Default value is 0.
523 540
 
524
-   Example 1.12. Set max_contacts parameter
541
+   Example 1.13. Set max_contacts parameter
525 542
 ...
526 543
 # Allow no more than 10 contacts per AOR
527 544
 modparam("registrar", "max_contacts", 10)
528 545
 ...
529 546
 
530
-3.14. retry_after (integer)
547
+3.15. retry_after (integer)
531 548
 
532 549
    The registrar can generate a 5xx reply to REGISTER requests in various
533 550
    situations. It can, for example, happen when the max_contacts parameter
... ...
@@ -542,12 +559,12 @@ modparam("registrar", "max_contacts", 10)
542 559
 
543 560
    Default value is 0 (disabled).
544 561
 
545
-   Example 1.13. Set retry_after parameter
562
+   Example 1.14. Set retry_after parameter
546 563
 ...
547 564
 modparam("registrar", "retry_after", 30)
548 565
 ...
549 566
 
550
-3.15. sock_flag (integer)
567
+3.16. sock_flag (integer)
551 568
 
552 569
    Message flag to signal to the registrar module to look into REGISTER
553 570
    request for a header which contains a socket description (IP:port).
... ...
@@ -558,12 +575,12 @@ modparam("registrar", "retry_after", 30)
558 575
 
559 576
    Default value is -1 (no flag).
560 577
 
561
-   Example 1.14. Set sock_flag parameter
578
+   Example 1.15. Set sock_flag parameter
562 579
 ...
563 580
 modparam("registrar", "sock_flag", 18)
564 581
 ...
565 582
 
566
-3.16. sock_hdr_name (string)
583
+3.17. sock_hdr_name (string)
567 584
 
568 585
    Header which contains a socket description (proto:IP:port) to override
569 586
    the received socket info. The header will be read only if the flag
... ...
@@ -573,12 +590,12 @@ modparam("registrar", "sock_flag", 18)
573 590
 
574 591
    Default value is NULL.
575 592
 
576
-   Example 1.15. Set sock_hdr_name parameter
593
+   Example 1.16. Set sock_hdr_name parameter
577 594
 ...
578 595
 modparam("registrar", "sock_hdr_name", "Sock-Info")
579 596
 ...
580 597
 
581
-3.17. method_filtering (integer)
598
+3.18. method_filtering (integer)
582 599
 
583 600
    Tells if the contact filtering based on supported methods should be
584 601
    performed during lookup on initial requests without to-tag. It's
... ...
@@ -588,12 +605,12 @@ modparam("registrar", "sock_hdr_name", "Sock-Info")
588 605
 
589 606
    Default value is 0 (disabled).
590 607
 
591
-   Example 1.16. Set method_filtering parameter
608
+   Example 1.17. Set method_filtering parameter
592 609
 ...
593 610
 modparam("registrar", "method_filtering", 1)
594 611
 ...
595 612
 
596
-3.18. use_path (integer)
613
+3.19. use_path (integer)
597 614
 
598 615
    If set to 1, the “Path:” header is handled according to the parameter
599 616
    This parameter can be modified via Kamailio config framework.
... ...
@@ -601,12 +618,12 @@ modparam("registrar", "method_filtering", 1)
601 618
 
602 619
    Default value is 0 (disabled).
603 620
 
604
-   Example 1.17. Set use_path parameter
621
+   Example 1.18. Set use_path parameter
605 622
 ...
606 623
 modparam("registrar", "use_path", 1)
607 624
 ...
608 625
 
609
-3.19. path_mode (integer)
626
+3.20. path_mode (integer)
610 627
 
611 628
    The registrar module implements three different modes regarding the
612 629
    response to a registration which includes one or more Path headers:
... ...
@@ -624,12 +641,12 @@ modparam("registrar", "use_path", 1)
624 641
 
625 642
    Default value is 2.
626 643
 
627
-   Example 1.18. Set path_mode parameter
644
+   Example 1.19. Set path_mode parameter
628 645
 ...
629 646
 modparam("registrar", "path_mode", 0)
630 647
 ...
631 648
 
632
-3.20. path_use_received (integer)
649
+3.21. path_use_received (integer)
633 650
 
634 651
    If set to 1, the “received” parameter of the first Path URI of a
635 652
    registration is set as received-uri and the NAT branch flag is set for
... ...
@@ -639,12 +656,12 @@ modparam("registrar", "path_mode", 0)
639 656
 
640 657
    Default value is 0 (disabled).
641 658
 
642
-   Example 1.19. Set path_use_received parameter
659
+   Example 1.20. Set path_use_received parameter
643 660
 ...
644 661
 modparam("registrar", "path_use_received", 1)
645 662
 ...
646 663
 
647
-3.21. path_check_local (integer)
664
+3.22. path_check_local (integer)
648 665
 
649 666
    If set to 1, when performing a lookup the Path (if present) is
650 667
    evaluated and if the first hop is local (according to “myself” test),
... ...
@@ -655,12 +672,12 @@ modparam("registrar", "path_use_received", 1)
655 672
 
656 673
    Default value is 0 (disabled).
657 674
 
658
-   Example 1.20. Set path_check_local parameter
675
+   Example 1.21. Set path_check_local parameter
659 676
 ...
660 677
 modparam("registrar", "path_check_local", 1)
661 678
 ...
662 679
 
663
-3.22. reg_callid_avp (string)
680
+3.23. reg_callid_avp (string)
664 681
 
665 682
    obsolete. use match_option in registered function
666 683
 
... ...
@@ -670,12 +687,12 @@ modparam("registrar", "path_check_local", 1)
670 687
 
671 688
    Default value is NULL (disabled).
672 689
 
673
-   Example 1.21. Set reg_callid_avp parameter
690
+   Example 1.22. Set reg_callid_avp parameter
674 691
 ...
675 692
 modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
676 693
 ...
677 694
 
678
-3.23. xavp_cfg (string)
695
+3.24. xavp_cfg (string)
679 696
 
680 697
    Defines the name of XAVP class to store runtime module config values.
681 698
    The values are stored as inner XAVPs, like $xavp(class=>attribute).
... ...
@@ -693,7 +710,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
693 710
 
694 711
    Default value is NULL (disabled).
695 712
 
696
-   Example 1.22. Set xavp_cfg parameter
713
+   Example 1.23. Set xavp_cfg parameter
697 714
 ...
698 715
 modparam("registrar", "xavp_cfg", "reg")
699 716
 ...
... ...
@@ -705,7 +722,7 @@ request_route {
705 722
 }
706 723
 ...
707 724
 
708
-3.24. xavp_rcd (string)
725
+3.25. xavp_rcd (string)
709 726
 
710 727
    Defines the name of XAVP class to store details from the location
711 728
    records. The values are stored as inner XAVPs, like
... ...
@@ -725,12 +742,12 @@ request_route {
725 742
 
726 743
    Default value is NULL (disabled).
727 744
 
728
-   Example 1.23. Set xavp_rcd parameter
745
+   Example 1.24. Set xavp_rcd parameter
729 746
 ...
730 747
 modparam("registrar", "xavp_rcd", "ulrcd")
731 748
 ...
732 749
 
733
-3.25. xavp_rcd_mask (int)
750
+3.26. xavp_rcd_mask (int)
734 751
 
735 752
    Defines what values to skip when xavp_rcd is stored.
736 753
      * 1 - ruid
... ...
@@ -741,7 +758,7 @@ modparam("registrar", "xavp_rcd", "ulrcd")
741 758
 
742 759
    Default value is 0 (none).
743 760
 
744
-   Example 1.24. Set xavp_rcd_mask parameter
761
+   Example 1.25. Set xavp_rcd_mask parameter
745 762
 ...
746 763
 # skip path value
747 764
 modparam("registrar", "xavp_rcd_mask", 16)
... ...
@@ -750,7 +767,7 @@ modparam("registrar", "xavp_rcd_mask", 16)
750 767
 modparam("registrar", "xavp_rcd_mask", 20)
751 768
 ...
752 769
 
753
-3.26. gruu_enabled (integer)
770
+3.27. gruu_enabled (integer)
754 771
 
755 772
    If set to 1 and the “+sip.instance” parameter to Contact header of
756 773
    REGISTER is present, then the value of the parameter is saved to
... ...
@@ -760,12 +777,12 @@ modparam("registrar", "xavp_rcd_mask", 20)
760 777
 
761 778
    Default value is 1 (enabled).
762 779
 
763
-   Example 1.25. Set gruu_enabled parameter
780
+   Example 1.26. Set gruu_enabled parameter
764 781
 ...
765 782
 modparam("registrar", "gruu_enabled", 0)
766 783
 ...
767 784
 
768
-3.27. outbound_mode (integer)
785
+3.28. outbound_mode (integer)
769 786
 
770 787
    If set to 0 this module will accept REGISTER requests that do not
771 788
    contain a “Supported:” header with the outbound options-tag. The 200 OK
... ...
@@ -788,12 +805,12 @@ modparam("registrar", "gruu_enabled", 0)
788 805
 
789 806
    Default value is 0.
790 807
 
791
-   Example 1.26. Set outbound_mode parameter
808
+   Example 1.27. Set outbound_mode parameter
792 809
 ...
793 810
 modparam("registrar", "outbound_mode", 2)
794 811
 ...
795 812
 
796
-3.28. regid_mode (integer)
813
+3.29. regid_mode (integer)
797 814
 
798 815
    If set to 0 this module will ignore the “regid” contact param when
799 816
    saving REGISTER request if the request does not indicate support for
... ...
@@ -805,12 +822,12 @@ modparam("registrar", "outbound_mode", 2)
805 822
 
806 823
    Default value is 0.
807 824
 
808
-   Example 1.27. Set regid_mode parameter
825
+   Example 1.28. Set regid_mode parameter
809 826
 ...
810 827
 modparam("registrar", "regid_mode", 1)
811 828
 ...
812 829
 
813
-3.29. flow_timer (integer)
830
+3.30. flow_timer (integer)
814 831
 
815 832
    If set to 0 then this module will not add a “Flow-Timer:” header to 200
816 833
    OK responses to REGISTER requests.
... ...
@@ -832,12 +849,12 @@ modparam("registrar", "regid_mode", 1)
832 849
 
833 850
    Default value is 0.
834 851
 
835
-   Example 1.28. Set flow_timer parameter
852
+   Example 1.29. Set flow_timer parameter
836 853
 ...
837 854
 modparam("registrar", "flow_timer", 25)
838 855
 ...
839 856
 
840
-3.30. contact_max_size (integer)
857
+3.31. contact_max_size (integer)
841 858
 
842 859
    Max size of URIs in “Contact:” header.
843 860
 
... ...
@@ -852,12 +869,12 @@ modparam("registrar", "flow_timer", 25)
852 869
 
853 870
    Default value is 512.
854 871
 
855
-   Example 1.29. Set contact_max_size parameter
872
+   Example 1.30. Set contact_max_size parameter
856 873
 ...
857 874
 modparam("registrar", "contact_max_size", 1024)
858 875
 ...
859 876
 
860
-3.31. event_callback (str)
877
+3.32. event_callback (str)
861 878
 
862 879
    The name of the function in the KEMI configuration file (embedded
863 880
    scripting language such as Lua, Python, ...) to be executed instead of
... ...
@@ -868,7 +885,7 @@ modparam("registrar", "contact_max_size", 1024)
868 885
 
869 886
    Default value is 'empty' (no function is executed for events).
870 887
 
871
-   Example 1.30. Set event_callback parameter
888
+   Example 1.31. Set event_callback parameter
872 889
 ...
873 890
 modparam("registrar", "event_callback", "ksr_registrar_event")
874 891
 ...
... ...
@@ -879,7 +896,7 @@ function ksr_registrar_event(evname)
879 896
 end
880 897
 ...
881 898
 
882
-3.32. lookup_filter_mode (int)
899
+3.33. lookup_filter_mode (int)
883 900
 
884 901
    Control what filters should be applied to lookup(...) operations. It
885 902
    can be a combination (sum) of the next values:
... ...
@@ -890,7 +907,7 @@ end
890 907
 
891 908
    Default value is NULL (disabled).
892 909
 
893
-   Example 1.31. Set xavp_cfg parameter
910
+   Example 1.32. Set xavp_cfg parameter
894 911
 ...
895 912
 modparam("registrar", "xavp_cfg", "reg")
896 913
 modparam("registrar", "lookup_filter_mode", 1)
... ...
@@ -956,7 +973,7 @@ request_route {
956 973
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
957 974
    REPLY_ROUTE.
958 975
 
959
-   Example 1.32. save usage
976
+   Example 1.33. save usage
960 977
 ...
961 978
 save("location");
962 979
 save("location", "0x01");
... ...
@@ -989,7 +1006,7 @@ save("location", "0x00", "sip:test@kamailio.org");
989 1006
 
990 1007
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
991 1008
 
992
-   Example 1.33. lookup usage
1009
+   Example 1.34. lookup usage
993 1010
 ...
994 1011
 lookup("location");
995 1012
 switch ($retcode) {
... ...
@@ -1015,7 +1032,7 @@ switch ($retcode) {
1015 1032
 
1016 1033
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1017 1034
 
1018
-   Example 1.34. lookup_branches usage
1035
+   Example 1.35. lookup_branches usage
1019 1036
 ...
1020 1037
 lookup_branches("location");
1021 1038
 ...
... ...
@@ -1047,7 +1064,7 @@ lookup_branches("location");
1047 1064
 
1048 1065
    This function can be used from ANY_ROUTE.
1049 1066
 
1050
-   Example 1.35. registered usage
1067
+   Example 1.36. registered usage
1051 1068
 ...
1052 1069
 if (registered("location")) {
1053 1070
         sl_send_reply("100", "Trying");
... ...
@@ -1074,7 +1091,7 @@ if (registered("location","$rz:$Au", 2)) {
1074 1091
 
1075 1092
    This function can be used from REQUEST_ROUTE.
1076 1093
 
1077
-   Example 1.36. add_sock_hdr usage
1094
+   Example 1.37. add_sock_hdr usage
1078 1095
 ...
1079 1096
 add_sock_hdr("Sock-Info");
1080 1097
 ...
... ...
@@ -1104,7 +1121,7 @@ add_sock_hdr("Sock-Info");
1104 1121
      * -2 - Error in unregistering user
1105 1122
      * -3 - Contacts for AOR not found
1106 1123
 
1107
-   Example 1.37. unregister usage
1124
+   Example 1.38. unregister usage
1108 1125
 ...
1109 1126
 unregister("location", "$ru");
1110 1127
 unregister("location", "sip:user@kamailio.org");
... ...
@@ -1128,7 +1145,7 @@ unregister("location", "", "$ruid");
1128 1145
 
1129 1146
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1130 1147
 
1131
-   Example 1.38. reg_fetch_contacts usage
1148
+   Example 1.39. reg_fetch_contacts usage
1132 1149
 ...
1133 1150
 reg_fetch_contacts("location", "$ru", "callee");
1134 1151
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
... ...
@@ -1147,7 +1164,7 @@ reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
1147 1164
 
1148 1165
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1149 1166
 
1150
-   Example 1.39. reg_free_contacts usage
1167
+   Example 1.40. reg_free_contacts usage
1151 1168
 ...
1152 1169
 reg_free_contacts("callee");
1153 1170
 ...
... ...
@@ -1161,7 +1178,7 @@ reg_free_contacts("callee");
1161 1178
 
1162 1179
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1163 1180
 
1164
-   Example 1.40. reg_send_reply usage
1181
+   Example 1.41. reg_send_reply usage
1165 1182
 ...
1166 1183
 save("location", "0x2");
1167 1184
 ...
... ...
@@ -1177,7 +1194,7 @@ reg_send_reply();
1177 1194
    Executed when a contact in location table has expired. The variable
1178 1195
    $ulc(exp=>...) is filled with the attributes of the expired contact.
1179 1196
 
1180
-   Example 1.41. event_route[usrloc:contact-expired] usage
1197
+   Example 1.42. event_route[usrloc:contact-expired] usage
1181 1198
 ...
1182 1199
 event_route[usrloc:contact-expired] {
1183 1200
     xlog("expired contact for $ulc(exp=>aor)\n");
... ...
@@ -1251,7 +1268,7 @@ event_route[usrloc:contact-expired] {
1251 1268
    The pseudo-variable accepts positive index value to access a specific
1252 1269
    contact record.
1253 1270
 
1254
-   Example 1.42. $ulc(name) usage
1271
+   Example 1.43. $ulc(name) usage
1255 1272
 ...
1256 1273
 if(reg_fetch_contacts("location", "$fu", "caller"))
1257 1274
 {