Browse code

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

Kamailio Dev authored on 03/07/2019 14:55:18
Showing 3 changed files
... ...
@@ -92,6 +92,11 @@ Chapter 1. Admin Guide
92 92
        also instruct the rating engine to debit the balance for the caller
93 93
        with the consumed amount. The callcontrol application is available
94 94
        from http://callcontrol.ag-projects.com/
95
+     * At the moment the callcontrol application only supports the old
96
+       “MI” interface for communication with Kamailio. This interface is
97
+       unfortunately not available anymore in Kamailio. So this
98
+       application can't be used right now together with the call_control
99
+       module.
95 100
      * A rating engine that is used to calculate the time limit based on
96 101
        the caller's credit and the destination price and to debit the
97 102
        caller's balance after a call ends. This is available as part of
... ...
@@ -8,16 +8,10 @@ Edited by
8 8
 
9 9
 Andreea-Ancuta Onofrei
10 10
 
11
-Edited by
12
-
13 11
 Juha Heinanen
14 12
 
15
-Edited by
16
-
17 13
 Olle E. Johansson
18 14
 
19
-Edited by
20
-
21 15
 Luis Martin
22 16
 
23 17
    Copyright © 2007-2008 Voice Sistem SRL
... ...
@@ -556,7 +550,9 @@ xlog("translated to var $var(y) \n");
556 556
 
557 557
 7.2. dialplan.reload
558 558
 
559
-   Forces an update of the translation rules from the database.
559
+   Perform a reload of the translation rules from the database. Note that
560
+   there is a rate limiting defined by 'reload_delta' paramenter. By
561
+   default is allowed maximum one reload in five seconds.
560 562
 
561 563
    Name: dialplan.reload
562 564
 
... ...
@@ -50,6 +50,7 @@ Ramona-Elena Modroiu
50 50
               3.17. reg_contact_addr (string)
51 51
               3.18. reg_keep_callid (int)
52 52
               3.19. reg_active (int)
53
+              3.20. reg_gc_interval (int)
53 54
 
54 55
         4. Functions
55 56
 
... ...
@@ -107,29 +108,30 @@ Ramona-Elena Modroiu
107 107
    1.17. Set reg_contact_addr parameter
108 108
    1.18. Set reg_keep_callid parameter
109 109
    1.19. Set reg_active parameter
110
-   1.20. uac_replace_from usage
110
+   1.20. Set reg_gc_interval parameter
111 111
    1.21. uac_replace_from usage
112
-   1.22. uac_restore_from usage
113
-   1.23. uac_replace_to usage
112
+   1.22. uac_replace_from usage
113
+   1.23. uac_restore_from usage
114 114
    1.24. uac_replace_to usage
115
-   1.25. uac_restore_to usage
116
-   1.26. uac_auth usage
117
-   1.27. uac_req_send usage
118
-   1.28. uac_reg_lookup usage
119
-   1.29. uac_reg_status usage
120
-   1.30. uac_reg_request_to usage
121
-   1.31. uac_reg_enable usage
122
-   1.32. uac_reg_disable usage
123
-   1.33. uac_reg_refresh usage
124
-   1.34. event_route[uac:reply] usage
125
-   1.35. uac.reg_dump usage
126
-   1.36. uac.reg_info usage
127
-   1.37. uac.reg_enable usage
128
-   1.38. uac.reg_disable usage
129
-   1.39. uac.reg_reload usage
130
-   1.40. uac.reg_refresh usage
131
-   1.41. uac.reg_active usage
132
-   1.42. lookup remote registrations usage
115
+   1.25. uac_replace_to usage
116
+   1.26. uac_restore_to usage
117
+   1.27. uac_auth usage
118
+   1.28. uac_req_send usage
119
+   1.29. uac_reg_lookup usage
120
+   1.30. uac_reg_status usage
121
+   1.31. uac_reg_request_to usage
122
+   1.32. uac_reg_enable usage
123
+   1.33. uac_reg_disable usage
124
+   1.34. uac_reg_refresh usage
125
+   1.35. event_route[uac:reply] usage
126
+   1.36. uac.reg_dump usage
127
+   1.37. uac.reg_info usage
128
+   1.38. uac.reg_enable usage
129
+   1.39. uac.reg_disable usage
130
+   1.40. uac.reg_reload usage
131
+   1.41. uac.reg_refresh usage
132
+   1.42. uac.reg_active usage
133
+   1.43. lookup remote registrations usage
133 134
 
134 135
 Chapter 1. Admin Guide
135 136
 
... ...
@@ -162,6 +164,7 @@ Chapter 1. Admin Guide
162 162
         3.17. reg_contact_addr (string)
163 163
         3.18. reg_keep_callid (int)
164 164
         3.19. reg_active (int)
165
+        3.20. reg_gc_interval (int)
165 166
 
166 167
    4. Functions
167 168
 
... ...
@@ -273,6 +276,7 @@ Chapter 1. Admin Guide
273 273
    3.17. reg_contact_addr (string)
274 274
    3.18. reg_keep_callid (int)
275 275
    3.19. reg_active (int)
276
+   3.20. reg_gc_interval (int)
276 277
 
277 278
 3.1. rr_from_store_param (string)
278 279
 
... ...
@@ -536,6 +540,22 @@ modparam("uac", "reg_keep_callid", 1)
536 536
 modparam("uac", "reg_active", 0)
537 537
 ...
538 538
 
539
+3.20. reg_gc_interval (int)
540
+
541
+   Timer interval (in seconds) at which remote registrations are cleaned
542
+   up in case of failure or removed. When setting it take in consideration
543
+   the maximum value for retransmission timeout, this param should be
544
+   greater than it. This value also impacts how ofter the reload for
545
+   remote registrations table can be executed -- the RPC command will fail
546
+   if executed in less than reg_gc_interval value since the last reload.
547
+
548
+   The default value is 150 seconds.
549
+
550
+   Example 1.20. Set reg_gc_interval parameter
551
+...
552
+modparam("uac", "reg_gc_interval", 60)
553
+...
554
+
539 555
 4. Functions
540 556
 
541 557
    4.1. uac_replace_from(display,uri)
... ...
@@ -583,7 +603,7 @@ modparam("uac", "reg_active", 0)
583 583
    dialog variables and registering callbacks in dialog module for in
584 584
    dialog requests.
585 585
 
586
-   Example 1.20. uac_replace_from usage
586
+   Example 1.21. uac_replace_from usage
587 587
 ...
588 588
 # replace both display and uri
589 589
 uac_replace_from("$avp(s:display)","$avp(s:uri)");
... ...
@@ -604,7 +624,7 @@ uac_replace_from("","");
604 604
 
605 605
    This function can be used from REQUEST_ROUTE and from BRANCH_ROUTE.
606 606
 
607
-   Example 1.21. uac_replace_from usage
607
+   Example 1.22. uac_replace_from usage
608 608
 ...
609 609
 uac_replace_from("sip:batman@gotham.org");
610 610
 ...
... ...
@@ -617,7 +637,7 @@ uac_replace_from("sip:batman@gotham.org");
617 617
 
618 618
    This function can be used from REQUEST_ROUTE.
619 619
 
620
-   Example 1.22. uac_restore_from usage
620
+   Example 1.23. uac_restore_from usage
621 621
 ...
622 622
 uac_restore_from();
623 623
 ...
... ...
@@ -634,7 +654,7 @@ uac_restore_from();
634 634
    automatically to display variable. That is no longer the case, if you
635 635
    expect that behavior, you will have to add the quotes by yourself.
636 636
 
637
-   Example 1.23. uac_replace_to usage
637
+   Example 1.24. uac_replace_to usage
638 638
 ...
639 639
 # replace both display and uri
640 640
 uac_replace_to("$avp(display)","$avp(uri)");
... ...
@@ -673,7 +693,7 @@ uac_replace_to("","");
673 673
    variables and registering callbacks in dialog module for in dialog
674 674
    requests.
675 675
 
676
-   Example 1.24. uac_replace_to usage
676
+   Example 1.25. uac_replace_to usage
677 677
 ...
678 678
 uac_replace_to("sip:batman@gotham.org");
679 679
 ...
... ...
@@ -686,7 +706,7 @@ uac_replace_to("sip:batman@gotham.org");
686 686
 
687 687
    This function can be used from REQUEST_ROUTE.
688 688
 
689
-   Example 1.25. uac_restore_to usage
689
+   Example 1.26. uac_restore_to usage
690 690
 ...
691 691
 uac_restore_to();
692 692
 ...
... ...
@@ -699,7 +719,7 @@ uac_restore_to();
699 699
 
700 700
    This function can be used from FAILURE_ROUTE.
701 701
 
702
-   Example 1.26. uac_auth usage
702
+   Example 1.27. uac_auth usage
703 703
 ...
704 704
 modparam("uac","auth_username_avp","$avp(auser)")
705 705
 modparam("uac","auth_password_avp","$avp(apass)")
... ...
@@ -736,7 +756,7 @@ failure_route[TRUNKAUTH] {
736 736
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
737 737
    BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.
738 738
 
739
-   Example 1.27. uac_req_send usage
739
+   Example 1.28. uac_req_send usage
740 740
 ...
741 741
 $uac_req(method)="OPTIONS";
742 742
 $uac_req(ruri)="sip:kamailio.org";
... ...
@@ -753,7 +773,7 @@ uac_req_send();
753 753
 
754 754
    This function can be used from ANY_ROUTE.
755 755
 
756
-   Example 1.28. uac_reg_lookup usage
756
+   Example 1.29. uac_reg_lookup usage
757 757
 ...
758 758
 
759 759
 if(uac_reg_lookup("$rU", "$ru"))
... ...
@@ -777,7 +797,7 @@ if(uac_reg_lookup("$rU", "$ru"))
777 777
 
778 778
    This function can be used from ANY_ROUTE.
779 779
 
780
-   Example 1.29. uac_reg_status usage
780
+   Example 1.30. uac_reg_status usage
781 781
 ...
782 782
 $var(status) = uac_reg_status("$rU");
783 783
 ...
... ...
@@ -796,7 +816,7 @@ $var(status) = uac_reg_status("$rU");
796 796
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
797 797
    BRANCH_ROUTE.
798 798
 
799
-   Example 1.30. uac_reg_request_to usage
799
+   Example 1.31. uac_reg_request_to usage
800 800
 ...
801 801
 
802 802
 if(uac_reg_request_to("$fU", 0))
... ...
@@ -824,7 +844,7 @@ failure_route[REMOTE_AUTH] {
824 824
 
825 825
    The SIP processing is done on the next timer routine.
826 826
 
827
-   Example 1.31. uac_reg_enable usage
827
+   Example 1.32. uac_reg_enable usage
828 828
 ...
829 829
    uac_reg_enable("l_uuid", "account123");
830 830
 ...
... ...
@@ -838,7 +858,7 @@ failure_route[REMOTE_AUTH] {
838 838
 
839 839
    The SIP processing is done on the next timer routine.
840 840
 
841
-   Example 1.32. uac_reg_disable usage
841
+   Example 1.33. uac_reg_disable usage
842 842
 ...
843 843
    uac_reg_disable("l_uuid", "account123");
844 844
 ...
... ...
@@ -849,7 +869,7 @@ failure_route[REMOTE_AUTH] {
849 849
    record was already loaded, new values are taken from database,
850 850
    otherwise a new record is created.
851 851
 
852
-   Example 1.33. uac_reg_refresh usage
852
+   Example 1.34. uac_reg_refresh usage
853 853
 ...
854 854
    uac_reg_refresh("account123");
855 855
 ...
... ...
@@ -873,7 +893,7 @@ failure_route[REMOTE_AUTH] {
873 873
    then the event_route is executed twice, first for 401/407 and second
874 874
    for final reply of the transaction.
875 875
 
876
-   Example 1.34. event_route[uac:reply] usage
876
+   Example 1.35. event_route[uac:reply] usage
877 877
 ...
878 878
 $uac_req(method)="OPTIONS";
879 879
 $uac_req(ruri)="sip:kamailio.org";
... ...
@@ -910,7 +930,7 @@ event_route[uac:reply] {
910 910
 
911 911
    Dump the content of remote registration table from memory.
912 912
 
913
-   Example 1.35. uac.reg_dump usage
913
+   Example 1.36. uac.reg_dump usage
914 914
 ...
915 915
    kamcmd uac.reg_dump
916 916
 ...
... ...
@@ -931,9 +951,10 @@ event_route[uac:reply] {
931 931
      * 16 (2^4) - registration initialized (after loading from database,
932 932
        the registration process was initialized)
933 933
 
934
-   Example 1.36. uac.reg_info usage
934
+   Example 1.37. uac.reg_info usage
935 935
 ...
936 936
    kamcmd uac.reg_info l_uuid account123
937
+   kamcmd uac.reg_info l_uuid s:12345678
937 938
 ...
938 939
 
939 940
 8.3.  uac.reg_enable
... ...
@@ -944,9 +965,10 @@ event_route[uac:reply] {
944 944
    matched against the value of the attribute in the remote registration
945 945
    record.
946 946
 
947
-   Example 1.37. uac.reg_enable usage
947
+   Example 1.38. uac.reg_enable usage
948 948
 ...
949 949
    kamcmd uac.reg_enable l_uuid account123
950
+   kamcmd uac.reg_enable l_uuid s:12345678
950 951
 ...
951 952
 
952 953
 8.4.  uac.reg_disable
... ...
@@ -957,16 +979,17 @@ event_route[uac:reply] {
957 957
    matched against the value of the attribute in the remote registration
958 958
    record.
959 959
 
960
-   Example 1.38. uac.reg_disable usage
960
+   Example 1.39. uac.reg_disable usage
961 961
 ...
962 962
    kamcmd uac.reg_disable l_uuid account123
963
+   kamcmd uac.reg_disable l_uuid s:12345678
963 964
 ...
964 965
 
965 966
 8.5.  uac.reg_reload
966 967
 
967 968
    Reload the records from database for remote registrations.
968 969
 
969
-   Example 1.39. uac.reg_reload usage
970
+   Example 1.40. uac.reg_reload usage
970 971
 ...
971 972
    kamcmd uac.reg_reload
972 973
 ...
... ...
@@ -977,9 +1000,10 @@ event_route[uac:reply] {
977 977
    the record exists in memory, it will be replaced with the new values
978 978
    loaded from database.
979 979
 
980
-   Example 1.40. uac.reg_refresh usage
980
+   Example 1.41. uac.reg_refresh usage
981 981
 ...
982 982
    kamcmd uac.reg_refresh account123
983
+   kamcmd uac.reg_refresh s:12345678
983 984
 ...
984 985
 
985 986
 8.7.  uac.reg_active
... ...
@@ -988,7 +1012,7 @@ event_route[uac:reply] {
988 988
    1 enables remote registrations for all records and 0 disables doing
989 989
    them.
990 990
 
991
-   Example 1.41. uac.reg_active usage
991
+   Example 1.42. uac.reg_active usage
992 992
 ...
993 993
    kamctl rpc uac.reg_active 0
994 994
    kamctl rpc uac.reg_active 1
... ...
@@ -1033,7 +1057,7 @@ event_route[uac:reply] {
1033 1033
    if the call is coming from a remote SIP provider and can change the
1034 1034
    R-URI to local username@domain. Afterwards you can run location lookup.
1035 1035
 
1036
-   Example 1.42. lookup remote registrations usage
1036
+   Example 1.43. lookup remote registrations usage
1037 1037
 ...
1038 1038
     if(uac_reg_lookup("$rU", "$ru")) {
1039 1039
         xlog("request from a remote SIP provider [$ou => $ru]\n");