Browse code

registrar: regenerated README

Charles Chance authored on 09/01/2015 20:48:19
Showing 1 changed files
... ...
@@ -20,7 +20,7 @@ Edited by
20 20
 
21 21
 Bogdan-Andre Iancu
22 22
 
23
-   Copyright � 2003 FhG FOKUS
23
+   Copyright © 2003 FhG FOKUS
24 24
      __________________________________________________________________
25 25
 
26 26
    Table of Contents
... ...
@@ -59,13 +59,14 @@ Bogdan-Andre Iancu
59 59
               3.18. use_path (integer)
60 60
               3.19. path_mode (integer)
61 61
               3.20. path_use_received (integer)
62
-              3.21. reg_callid_avp (string)
63
-              3.22. xavp_cfg (string)
64
-              3.23. xavp_rcd (string)
65
-              3.24. gruu_enabled (integer)
66
-              3.25. outbound_mode (integer)
67
-              3.26. regid_mode (integer)
68
-              3.27. flow_timer (integer)
62
+              3.21. path_check_local (integer)
63
+              3.22. reg_callid_avp (string)
64
+              3.23. xavp_cfg (string)
65
+              3.24. xavp_rcd (string)
66
+              3.25. gruu_enabled (integer)
67
+              3.26. outbound_mode (integer)
68
+              3.27. regid_mode (integer)
69
+              3.28. flow_timer (integer)
69 70
 
70 71
         4. Functions
71 72
 
... ...
@@ -117,23 +118,24 @@ Bogdan-Andre Iancu
117 118
    1.17. Set use_path parameter
118 119
    1.18. Set path_mode parameter
119 120
    1.19. Set path_use_received parameter
120
-   1.20. Set reg_callid_avp parameter
121
-   1.21. Set xavp_cfg parameter
122
-   1.22. Set xavp_rcd parameter
123
-   1.23. Set gruu_enabled parameter
124
-   1.24. Set outbound_mode parameter
125
-   1.25. Set regid_mode parameter
126
-   1.26. Set flow_timer parameter
127
-   1.27. save usage
128
-   1.28. lookup usage
129
-   1.29. lookup_branches usage
130
-   1.30. registered usage
131
-   1.31. add_sock_hdr usage
132
-   1.32. unregister usage
133
-   1.33. reg_fetch_contacts usage
134
-   1.34. reg_free_contacts usage
135
-   1.35. event_route[usrloc:contact-expired] usage
136
-   1.36. $ulc(name) usage
121
+   1.20. Set path_check_local parameter
122
+   1.21. Set reg_callid_avp parameter
123
+   1.22. Set xavp_cfg parameter
124
+   1.23. Set xavp_rcd parameter
125
+   1.24. Set gruu_enabled parameter
126
+   1.25. Set outbound_mode parameter
127
+   1.26. Set regid_mode parameter
128
+   1.27. Set flow_timer parameter
129
+   1.28. save usage
130
+   1.29. lookup usage
131
+   1.30. lookup_branches usage
132
+   1.31. registered usage
133
+   1.32. add_sock_hdr usage
134
+   1.33. unregister usage
135
+   1.34. reg_fetch_contacts usage
136
+   1.35. reg_free_contacts usage
137
+   1.36. event_route[usrloc:contact-expired] usage
138
+   1.37. $ulc(name) usage
137 139
 
138 140
 Chapter 1. Admin Guide
139 141
 
... ...
@@ -171,13 +173,14 @@ Chapter 1. Admin Guide
171 173
         3.18. use_path (integer)
172 174
         3.19. path_mode (integer)
173 175
         3.20. path_use_received (integer)
174
-        3.21. reg_callid_avp (string)
175
-        3.22. xavp_cfg (string)
176
-        3.23. xavp_rcd (string)
177
-        3.24. gruu_enabled (integer)
178
-        3.25. outbound_mode (integer)
179
-        3.26. regid_mode (integer)
180
-        3.27. flow_timer (integer)
176
+        3.21. path_check_local (integer)
177
+        3.22. reg_callid_avp (string)
178
+        3.23. xavp_cfg (string)
179
+        3.24. xavp_rcd (string)
180
+        3.25. gruu_enabled (integer)
181
+        3.26. outbound_mode (integer)
182
+        3.27. regid_mode (integer)
183
+        3.28. flow_timer (integer)
181 184
 
182 185
    4. Functions
183 186
 
... ...
@@ -226,8 +229,8 @@ Chapter 1. Admin Guide
226 229
      * off - stores the value of the Path headers into usrloc without
227 230
        passing it back to the UAC in the reply.
228 231
      * lazy - stores the Path header and passes it back to the UAC if
229
-       Path-support is indicated by the "path" param in the Supported HF.
230
-     * strict - rejects the registration with "420 Bad Extension" if
232
+       Path-support is indicated by the “path” param in the Supported HF.
233
+     * strict - rejects the registration with “420 Bad Extension” if
231 234
        there's a Path header but no support for it is indicated by the
232 235
        UAC. Otherwise it's stored and passed back to the UAC.
233 236
 
... ...
@@ -239,8 +242,8 @@ Chapter 1. Admin Guide
239 242
    client's NAT).
240 243
 
241 244
    The whole process is transparent to the user, so no config changes are
242
-   required beside setting the registrar-parameters "use_path" and
243
-   "path_mode".
245
+   required beside setting the registrar-parameters “use_path” and
246
+   “path_mode”.
244 247
 
245 248
 1.2. GRUU Support
246 249
 
... ...
@@ -292,13 +295,14 @@ Chapter 1. Admin Guide
292 295
    3.18. use_path (integer)
293 296
    3.19. path_mode (integer)
294 297
    3.20. path_use_received (integer)
295
-   3.21. reg_callid_avp (string)
296
-   3.22. xavp_cfg (string)
297
-   3.23. xavp_rcd (string)
298
-   3.24. gruu_enabled (integer)
299
-   3.25. outbound_mode (integer)
300
-   3.26. regid_mode (integer)
301
-   3.27. flow_timer (integer)
298
+   3.21. path_check_local (integer)
299
+   3.22. reg_callid_avp (string)
300
+   3.23. xavp_cfg (string)
301
+   3.24. xavp_rcd (string)
302
+   3.25. gruu_enabled (integer)
303
+   3.26. outbound_mode (integer)
304
+   3.27. regid_mode (integer)
305
+   3.28. flow_timer (integer)
302 306
 
303 307
 3.1. default_expires (integer)
304 308
 
... ...
@@ -306,7 +310,7 @@ Chapter 1. Admin Guide
306 310
    contact parameters, this value will be used for newly created usrloc
307 311
    records. The parameter contains number of second to expire (for example
308 312
    use 3600 for one hour). If it is set to a lower value than the
309
-   "min_expires" parameter then it will be ignored. This parameter can be
313
+   “min_expires” parameter then it will be ignored. This parameter can be
310 314
    modified via ser config framework. A random value in a specific
311 315
    interval can be selected by using the default_expires_range parameter
312 316
 
... ...
@@ -321,7 +325,7 @@ modparam("registrar", "default_expires", 1800)
321 325
 
322 326
    This parameter specifies that the expiry used for newly created usrloc
323 327
    records are not fixed, but a random value in the interval
324
-   "[default_expires-default_expires_range%, default_expires]". The value
328
+   “[default_expires-default_expires_range%, default_expires]”. The value
325 329
    is between 0 and 100 and represent the maximim percentage from expires
326 330
    that will be substracted when computing the value. Default is 0,
327 331
    meaning default_expires is left unmodified. This parameter can be
... ...
@@ -350,7 +354,7 @@ res]
350 354
 
351 355
 3.4. min_expires (integer)
352 356
 
353
-   The minimum expires value of a "Contact". Values lower than this
357
+   The minimum expires value of a “Contact”. Values lower than this
354 358
    minimum will be automatically set to the minimum. Value 0 disables the
355 359
    checking. This parameter can be modified via the Kamailio config
356 360
    framework.
... ...
@@ -364,7 +368,7 @@ modparam("registrar", "min_expires", 60)
364 368
 
365 369
 3.5. max_expires (integer)
366 370
 
367
-   The maximum accepted expires value of a "Contact", values higher than
371
+   The maximum accepted expires value of a “Contact”, values higher than
368 372
    this maximum will be automatically set to the maximum. Value 0 disables
369 373
    the checking. This parameter can be modified via the Kamailio config
370 374
    framework.
... ...
@@ -378,7 +382,7 @@ modparam("registrar", "max_expires", 120)
378 382
 
379 383
 3.6. default_q (integer)
380 384
 
381
-   The parameter represents default "q" value for new contacts. Because
385
+   The parameter represents default “q” value for new contacts. Because
382 386
    Kamailio doesn't support float parameter types, the value in the
383 387
    parameter is divided by 1000 and stored as float. For example, if you
384 388
    want default_q to be 0.38, use value 380 here. This parameter can be
... ...
@@ -468,7 +472,7 @@ modparam("registrar", "received_avp", "$avp(s:rcv)")
468 472
 3.12. received_param (string)
469 473
 
470 474
    The name of the parameter that will be appended to Contact URI's of 200
471
-   OK when the received URI was set by the "nathelper" module. If the
475
+   OK when the received URI was set by the “nathelper” module. If the
472 476
    value is an empty string, then the parameter is not appended anymore.
473 477
 
474 478
    Default value is "received".
... ...
@@ -551,7 +555,7 @@ modparam("registrar", "sock_hdr_name", "Sock-Info")
551 555
 
552 556
    Tells if the contact filtering based on supported methods should be
553 557
    performed during lookup. It's enabled only if it has a non zero value.
554
-   Supported methods are listed in the "Allow:" header in the REGISTER
558
+   Supported methods are listed in the “Allow:” header in the REGISTER
555 559
    message and stored in the location database.
556 560
 
557 561
    Default value is 0 (disabled).
... ...
@@ -563,9 +567,9 @@ modparam("registrar", "method_filtering", 1)
563 567
 
564 568
 3.18. use_path (integer)
565 569
 
566
-   If set to 1, the "Path:" header is handled according to the parameter
570
+   If set to 1, the “Path:” header is handled according to the parameter
567 571
    This parameter can be modified via Kamailio config framework.
568
-   "path_mode".
572
+   “path_mode”.
569 573
 
570 574
    Default value is 0 (disabled).
571 575
 
... ...
@@ -582,12 +586,12 @@ modparam("registrar", "use_path", 1)
582 586
        the reply.
583 587
      * 1 - The Path header is saved into usrloc, but is only included in
584 588
        the reply if path support is indicated in the registration request
585
-       by the "path" option in the "Supported:" header.
589
+       by the “path” option in the “Supported:” header.
586 590
      * 2 - The path header is only saved into usrloc, if path support is
587
-       indicated in the registration request by the "path" option of the
588
-       "Supported" header. If no path support is indicated, the request is
589
-       rejected with "420 - Bad Extension" and the header "Unsupported:
590
-       path" is included in the reply along with the received "Path"
591
+       indicated in the registration request by the “path” option of the
592
+       “Supported” header. If no path support is indicated, the request is
593
+       rejected with “420 - Bad Extension” and the header “Unsupported:
594
+       path” is included in the reply along with the received “Path”
591 595
        header. This mode is the one recommended by RFC-3327.
592 596
 
593 597
    Default value is 2.
... ...
@@ -599,10 +603,10 @@ modparam("registrar", "path_mode", 0)
599 603
 
600 604
 3.20. path_use_received (integer)
601 605
 
602
-   If set to 1, the "received" parameter of the first Path URI of a
606
+   If set to 1, the “received” parameter of the first Path URI of a
603 607
    registration is set as received-uri and the NAT branch flag is set for
604 608
    this contact. This is useful if the registrar is placed behind a SIP
605
-   loadbalancer, which passes the nat'ed UAC address as "received"
609
+   loadbalancer, which passes the nat'ed UAC address as “received”
606 610
    parameter in it's Path uri.
607 611
 
608 612
    Default value is 0 (disabled).
... ...
@@ -612,7 +616,23 @@ modparam("registrar", "path_mode", 0)
612 616
 modparam("registrar", "path_use_received", 1)
613 617
 ...
614 618
 
615
-3.21. reg_callid_avp (string)
619
+3.21. path_check_local (integer)
620
+
621
+   If set to 1, when performing a lookup the Path (if present) is
622
+   evaluated and if the first hop is local (according to “myself” test),
623
+   we skip it to avoid unnecessary looping.
624
+
625
+   This is useful if multiple servers are sharing a common location
626
+   database, each saving contacts with their local address as the Path.
627
+
628
+   Default value is 0 (disabled).
629
+
630
+   Example 1.20. Set path_check_local parameter
631
+...
632
+modparam("registrar", "path_check_local", 1)
633
+...
634
+
635
+3.22. reg_callid_avp (string)
616 636
 
617 637
    If reg_callid_avp is defined and populated when the registered() is
618 638
    invoked, the result is TRUE only if an active registration with the
... ...
@@ -620,12 +640,12 @@ modparam("registrar", "path_use_received", 1)
620 640
 
621 641
    Default value is NULL (disabled).
622 642
 
623
-   Example 1.20. Set reg_callid_avp parameter
643
+   Example 1.21. Set reg_callid_avp parameter
624 644
 ...
625 645
 modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
626 646
 ...
627 647
 
628
-3.22. xavp_cfg (string)
648
+3.23. xavp_cfg (string)
629 649
 
630 650
    Defines the name of XAVP class to store runtime module config values.
631 651
    The values are stored as inner XAVPs, like $xavp(class=>attribute).
... ...
@@ -643,12 +663,12 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
643 663
 
644 664
    Default value is NULL (disabled).
645 665
 
646
-   Example 1.21. Set xavp_cfg parameter
666
+   Example 1.22. Set xavp_cfg parameter
647 667
 ...
648 668
 modparam("registrar", "xavp_cfg", "reg")
649 669
 ...
650 670
 
651
-3.23. xavp_rcd (string)
671
+3.24. xavp_rcd (string)
652 672
 
653 673
    Defines the name of XAVP class to store details from the location
654 674
    records. The values are stored as inner XAVPs, like
... ...
@@ -660,14 +680,14 @@ modparam("registrar", "xavp_cfg", "reg")
660 680
 
661 681
    Default value is NULL (disabled).
662 682
 
663
-   Example 1.22. Set xavp_rcd parameter
683
+   Example 1.23. Set xavp_rcd parameter
664 684
 ...
665 685
 modparam("registrar", "xavp_rcd", "ulrcd")
666 686
 ...
667 687
 
668
-3.24. gruu_enabled (integer)
688
+3.25. gruu_enabled (integer)
669 689
 
670
-   If set to 1 and the "+sip.instance" parameter to Contact header of
690
+   If set to 1 and the “+sip.instance” parameter to Contact header of
671 691
    REGISTER is present, then the value of the parameter is saved to
672 692
    location and pub-gruu and temp-gruu addresses are generated.
673 693
 
... ...
@@ -675,62 +695,62 @@ modparam("registrar", "xavp_rcd", "ulrcd")
675 695
 
676 696
    Default value is 1 (enabled).
677 697
 
678
-   Example 1.23. Set gruu_enabled parameter
698
+   Example 1.24. Set gruu_enabled parameter
679 699
 ...
680 700
 modparam("registrar", "gruu_enabled", 0)
681 701
 ...
682 702
 
683
-3.25. outbound_mode (integer)
703
+3.26. outbound_mode (integer)
684 704
 
685 705
    If set to 0 this module will accept REGISTER requests that do not
686
-   contain a "Supported:" header with the outbound options-tag. The 200 OK
706
+   contain a “Supported:” header with the outbound options-tag. The 200 OK
687 707
    response to REGISTER requests that this module generates will not
688
-   contain "Require:" or "Supported:" headers with the outbound
689
-   options-tag. If the client has a "Require:" header with the outbound
690
-   options tag the REGISTER will be rejected with a "420 Bad Extension"
708
+   contain “Require:” or “Supported:” headers with the outbound
709
+   options-tag. If the client has a “Require:” header with the outbound
710
+   options tag the REGISTER will be rejected with a “420 Bad Extension”
691 711
    response.
692 712
 
693 713
    If set to 1 this module will accept REGISTER requests that do not
694
-   contain a "Supported:" header with the outbound options-tag and
714
+   contain a “Supported:” header with the outbound options-tag and
695 715
    REGISTER requests that do contain a Supported: or Requires: header with
696 716
    the outbound options-tag. When the client supports outbound the
697 717
    appropriate RFC5626 procedures will be followed.
698 718
 
699 719
    If set to 2 this module will reject REGISTER requests that do not
700
-   contain a "Supported:" header with the outbound options-tag. When the
720
+   contain a “Supported:” header with the outbound options-tag. When the
701 721
    client supports outbound the appropriate RFC5626 procedures will be
702 722
    followed.
703 723
 
704 724
    Default value is 0.
705 725
 
706
-   Example 1.24. Set outbound_mode parameter
726
+   Example 1.25. Set outbound_mode parameter
707 727
 ...
708 728
 modparam("registrar", "outbound_mode", 2)
709 729
 ...
710 730
 
711
-3.26. regid_mode (integer)
731
+3.27. regid_mode (integer)
712 732
 
713
-   If set to 0 this module will ignore the "regid" contact param when
733
+   If set to 0 this module will ignore the “regid” contact param when
714 734
    saving REGISTER request if the request does not indicate support for
715 735
    outbound.
716 736
 
717
-   If set to 1 this module will use "regid" contact param (if present)
737
+   If set to 1 this module will use “regid” contact param (if present)
718 738
    when saving REGISTER request even if REGISTER request does not indicate
719 739
    support for outbound.
720 740
 
721 741
    Default value is 0.
722 742
 
723
-   Example 1.25. Set regid_mode parameter
743
+   Example 1.26. Set regid_mode parameter
724 744
 ...
725 745
 modparam("registrar", "regid_mode", 1)
726 746
 ...
727 747
 
728
-3.27. flow_timer (integer)
748
+3.28. flow_timer (integer)
729 749
 
730
-   If set to 0 then this module will not add a "Flow-Timer:" header to 200
750
+   If set to 0 then this module will not add a “Flow-Timer:” header to 200
731 751
    OK responses to REGISTER requests.
732 752
 
733
-   If set to > 0 then this module will add a "Flow-Timer:" header
753
+   If set to > 0 then this module will add a “Flow-Timer:” header
734 754
    containing this value to 200 OK responses to REGISTER requests. This
735 755
    parameter may only be set to a value > 0 when outbound_mode is set to 1
736 756
    or 2.
... ...
@@ -742,12 +762,12 @@ modparam("registrar", "regid_mode", 1)
742 762
    useful when you have a single edge proxy/registrar or if you have an
743 763
    edge proxy that cannot modify responses. If you are using a separate
744 764
    edge proxy you should consider leaving this parameter set to 0 and
745
-   adding the "Flow-Timer:" header on the edge proxy as this allows you to
765
+   adding the “Flow-Timer:” header on the edge proxy as this allows you to
746 766
    keep all of the timer values for a specific flow in one configuration.
747 767
 
748 768
    Default value is 0.
749 769
 
750
-   Example 1.26. Set flow_timer parameter
770
+   Example 1.27. Set flow_timer parameter
751 771
 ...
752 772
 modparam("registrar", "flow_timer", 25)
753 773
 ...
... ...
@@ -763,12 +783,12 @@ modparam("registrar", "flow_timer", 25)
763 783
    4.7. reg_fetch_contacts(domain, uri, profile)
764 784
    4.8. reg_free_contacts(profile)
765 785
 
766
-4.1. save(domain, [, flags [, uri]])
786
+4.1.  save(domain, [, flags [, uri]])
767 787
 
768 788
    The function processes a REGISTER message. It can add, remove or modify
769 789
    location records (in usrloc) depending on Contact and Expires HFs in
770 790
    the REGISTER message. On success and when called from the
771
-   REQUEST_ROUTE, "200 OK" will be returned listing all contacts that are
791
+   REQUEST_ROUTE, “200 OK” will be returned listing all contacts that are
772 792
    currently in the location database. On an error, an error message will
773 793
    be sent with a short description in reason phrase.
774 794
 
... ...
@@ -801,14 +821,14 @@ modparam("registrar", "flow_timer", 25)
801 821
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
802 822
    REPLY_ROUTE.
803 823
 
804
-   Example 1.27. save usage
824
+   Example 1.28. save usage
805 825
 ...
806 826
 save("location");
807 827
 save("location", "0x01");
808 828
 save("location", "0x00", "sip:test@kamailio.org");
809 829
 ...
810 830
 
811
-4.2. lookup(domain [, uri])
831
+4.2.  lookup(domain [, uri])
812 832
 
813 833
    The lookup function extracts username and/or domain from Request-URI
814 834
    and tries to find all contacts for the username in usrloc. If there are
... ...
@@ -834,7 +854,7 @@ save("location", "0x00", "sip:test@kamailio.org");
834 854
 
835 855
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
836 856
 
837
-   Example 1.28. lookup usage
857
+   Example 1.29. lookup usage
838 858
 ...
839 859
 lookup("location");
840 860
 switch ($retcode) {
... ...
@@ -848,7 +868,7 @@ switch ($retcode) {
848 868
 };
849 869
 ...
850 870
 
851
-4.3. lookup_branches(domain)
871
+4.3.  lookup_branches(domain)
852 872
 
853 873
    The function performs lookup(domain) on r-uri and additional branches
854 874
    (only branches that have no other attributes set than uri).
... ...
@@ -860,12 +880,12 @@ switch ($retcode) {
860 880
 
861 881
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
862 882
 
863
-   Example 1.29. lookup_branches usage
883
+   Example 1.30. lookup_branches usage
864 884
 ...
865 885
 lookup_branches("location");
866 886
 ...
867 887
 
868
-4.4. registered(domain [, uri])
888
+4.4.  registered(domain [, uri])
869 889
 
870 890
    The function returns true if the AOR in the Request-URI is registered,
871 891
    false otherwise. The function does not modify the message being
... ...
@@ -879,7 +899,7 @@ lookup_branches("location");
879 899
 
880 900
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
881 901
 
882
-   Example 1.30. registered usage
902
+   Example 1.31. registered usage
883 903
 ...
884 904
 if (registered("location")) {
885 905
         sl_send_reply("100", "Trying");
... ...
@@ -887,9 +907,9 @@ if (registered("location")) {
887 907
 };
888 908
 ...
889 909
 
890
-4.5. add_sock_hdr(hdr_name)
910
+4.5.  add_sock_hdr(hdr_name)
891 911
 
892
-   Adds a new header to the current REGISTER request with "hdr_name" which
912
+   Adds a new header to the current REGISTER request with “hdr_name” which
893 913
    contains the description of the received socket (proto:ip:port)
894 914
 
895 915
    This makes sense only in multiple replicated servers scenarios.
... ...
@@ -899,17 +919,17 @@ if (registered("location")) {
899 919
 
900 920
    This function can be used from REQUEST_ROUTE.
901 921
 
902
-   Example 1.31. add_sock_hdr usage
922
+   Example 1.32. add_sock_hdr usage
903 923
 ...
904 924
 add_sock_hdr("Sock-Info");
905 925
 ...
906 926
 
907
-4.6. unregister(domain, uri[, ruid])
927
+4.6.  unregister(domain, uri[, ruid])
908 928
 
909 929
    The function removes contacts associated with 'uri' from the location
910 930
    database. If 'ruid' is provided a specific contact is removed, if
911 931
    'ruid' is not provided all the current contacts are removed. If 'ruid'
912
-   is provided and the "usrloc" module is using "db_mode=3", 'uri' does
932
+   is provided and the “usrloc” module is using “db_mode=3”, 'uri' does
913 933
    not need to be given and can be empty string.
914 934
 
915 935
    Meaning of the parameters is as follows:
... ...
@@ -923,7 +943,7 @@ add_sock_hdr("Sock-Info");
923 943
 
924 944
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
925 945
 
926
-   Example 1.32. unregister usage
946
+   Example 1.33. unregister usage
927 947
 ...
928 948
 unregister("location", "$ru");
929 949
 unregister("location", "sip:user@kamailio.org");
... ...
@@ -931,7 +951,7 @@ unregister("location", "$ru", "$ulc(caller=>ruid)");
931 951
 unregister("location", "", "$ruid");
932 952
 ...
933 953
 
934
-4.7. reg_fetch_contacts(domain, uri, profile)
954
+4.7.  reg_fetch_contacts(domain, uri, profile)
935 955
 
936 956
    The function fetches the contacts for 'uri' from table 'domain' to
937 957
    pseudo-variable $ulc(profile).
... ...
@@ -947,13 +967,13 @@ unregister("location", "", "$ruid");
947 967
 
948 968
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
949 969
 
950
-   Example 1.33. reg_fetch_contacts usage
970
+   Example 1.34. reg_fetch_contacts usage
951 971
 ...
952 972
 reg_fetch_contacts("location", "$ru", "callee");
953 973
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
954 974
 ...
955 975
 
956
-4.8. reg_free_contacts(profile)
976
+4.8.  reg_free_contacts(profile)
957 977
 
958 978
    The function frees the contacts from pseudo-variable $ulc(profile).
959 979
    Should be called to release the content of a profile. Anyhow, fetching
... ...
@@ -966,7 +986,7 @@ reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
966 986
 
967 987
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
968 988
 
969
-   Example 1.34. reg_free_contacts usage
989
+   Example 1.35. reg_free_contacts usage
970 990
 ...
971 991
 reg_free_contacts("callee");
972 992
 ...
... ...
@@ -980,7 +1000,7 @@ reg_free_contacts("callee");
980 1000
    Executed when a contact in location table has expired. The variable
981 1001
    $ulc(exp=>...) is filled with the attributes of the expired contact.
982 1002
 
983
-   Example 1.35. event_route[usrloc:contact-expired] usage
1003
+   Example 1.36. event_route[usrloc:contact-expired] usage
984 1004
 ...
985 1005
 event_route[usrloc:contact-expired] {
986 1006
     xlog("expired contact for $ulc(exp=>aor)\n");
... ...
@@ -1022,12 +1042,12 @@ event_route[usrloc:contact-expired] {
1022 1042
 7.1. $ulc(profile=>attr)
1023 1043
 
1024 1044
    Access the attributes of contact addresses stored in 'profile'. It must
1025
-   be used after a call of "reg_fetch_contacts()".
1045
+   be used after a call of “reg_fetch_contacts()”.
1026 1046
 
1027
-   The "profile" has to be one of the values used with
1028
-   "reg_fetch_contacts()".
1047
+   The “profile” has to be one of the values used with
1048
+   “reg_fetch_contacts()”.
1029 1049
 
1030
-   The "attr" can be:
1050
+   The “attr” can be:
1031 1051
      * aor - address of record
1032 1052
      * domain - use location domain name
1033 1053
      * aorhash - hash id for the record
... ...
@@ -1052,7 +1072,7 @@ event_route[usrloc:contact-expired] {
1052 1072
    The pseudo-variable accepts positive index value to access a specific
1053 1073
    contact record.
1054 1074
 
1055
-   Example 1.36. $ulc(name) usage
1075
+   Example 1.37. $ulc(name) usage
1056 1076
 ...
1057 1077
 if(reg_fetch_contacts("location", "$fu", "caller"))
1058 1078
 {
... ...
@@ -1084,9 +1104,9 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
1084 1104
 
1085 1105
 Chapter 2. Frequently Asked Questions
1086 1106
 
1087
-   2.1. What happend with the old "nat_flag" module parameter?
1088
-   2.2. What happend with the old "use_domain" module parameter?
1089
-   2.3. What happened with the old "save_noreply" and "save_memory"
1107
+   2.1. What happend with the old “nat_flag” module parameter?
1108
+   2.2. What happend with the old “use_domain” module parameter?
1109
+   2.3. What happened with the old “save_noreply” and “save_memory”
1090 1110
           functions?
1091 1111
 
1092 1112
    2.4. Where can I find more about Kamailio?
... ...
@@ -1096,23 +1116,23 @@ Chapter 2. Frequently Asked Questions
1096 1116
 
1097 1117
    2.1.
1098 1118
 
1099
-   What happend with the old "nat_flag" module parameter?
1119
+   What happend with the old “nat_flag” module parameter?
1100 1120
 
1101 1121
    In was removed, as the module internally loads this value from the
1102
-   "USRLOC" module (see the "nat_bflag" USRLOC parameter).
1122
+   “USRLOC” module (see the “nat_bflag” USRLOC parameter).
1103 1123
 
1104 1124
    2.2.
1105 1125
 
1106
-   What happend with the old "use_domain" module parameter?
1126
+   What happend with the old “use_domain” module parameter?
1107 1127
 
1108 1128
    In was removed, as the module internally loads this option from the
1109
-   "USRLOC" module. This was done in order to simplify the configuration.
1129
+   “USRLOC” module. This was done in order to simplify the configuration.
1110 1130
 
1111 1131
    2.3.
1112 1132
 
1113
-   What happened with the old "save_noreply" and "save_memory" functions?
1133
+   What happened with the old “save_noreply” and “save_memory” functions?
1114 1134
 
1115
-   There functions were merged into the new "save(domain,flags)"
1135
+   There functions were merged into the new “save(domain,flags)”
1116 1136
    functions. If a reply should be sent or if the DB should be updated
1117 1137
    also is controlled via the flags.
1118 1138