Browse code

modules: readme files regenerated - matrix ...

Kamailio Dev authored on 24/12/2016 09:31:18
Showing 3 changed files
... ...
@@ -36,9 +36,9 @@ Henning Westerholt
36 36
 
37 37
               4.1. matrix (string first, string second, string dstavp)
38 38
 
39
-        5. MI Commands
39
+        5. RPC Commands
40 40
 
41
-              5.1. reload_matrix
41
+              5.1. matrix.reload
42 42
 
43 43
         6. Installation and Running
44 44
 
... ...
@@ -60,7 +60,7 @@ Henning Westerholt
60 60
    1.4. Set matrix_second_col parameter
61 61
    1.5. Set matrix_res_col parameter
62 62
    1.6. matrix usage
63
-   1.7. reload_matrix usage
63
+   1.7. matrix.reload usage
64 64
    1.8. Example database content - matrix table
65 65
    2.1. Set db_url parameter
66 66
    2.2. Set matrix_table parameter
... ...
@@ -90,9 +90,9 @@ Chapter 1. Admin Guide
90 90
 
91 91
         4.1. matrix (string first, string second, string dstavp)
92 92
 
93
-   5. MI Commands
93
+   5. RPC Commands
94 94
 
95
-        5.1. reload_matrix
95
+        5.1. matrix.reload
96 96
 
97 97
    6. Installation and Running
98 98
 
... ...
@@ -209,18 +209,18 @@ if (!matrix("$avp(first)", "$avp(second)", "$avp(route_tree)"))
209 209
 cr_route("$avp(route_tree)", "$rd", "$rU", "$rU", "call_id");
210 210
 ...
211 211
 
212
-5. MI Commands
212
+5. RPC Commands
213 213
 
214
-   5.1. reload_matrix
214
+   5.1. matrix.reload
215 215
 
216
-5.1.  reload_matrix
216
+5.1.  matrix.reload
217 217
 
218 218
    Reloads the internal matrix representation from the database. This is
219 219
    necessary after entries in the database have been changed.
220 220
 
221
-   Example 1.7. reload_matrix usage
221
+   Example 1.7. matrix.reload usage
222 222
 ...
223
-kamctl fifo reload_matrix
223
+kamcmd matrix.reload
224 224
 ...
225 225
 
226 226
 6. Installation and Running
... ...
@@ -129,27 +129,36 @@ Daniel-Constantin Mierla
129 129
               4.50. t_use_uac_headers()
130 130
               4.51. t_is_retr_async_reply()
131 131
 
132
-        5. TM Module API
132
+        5. RPC Commands
133 133
 
134
-              5.1. Defines
135
-              5.2. Functions
134
+              5.1. tm.t_uac_start
135
+              5.2. tm.t_uac_wait
136
+              5.3. tm.cancel
137
+              5.4. tm.hash_stats
138
+              5.5. tm.reply
139
+              5.6. tm.reply_callid
136 140
 
137
-                    5.2.1. register_tmcb(cb_type, cb_func)
138
-                    5.2.2. load_tm(*import_structure)
139
-                    5.2.3. int t_suspend(struct sip_msg *msg, unsigned int
141
+        6. Event Routes
142
+
143
+              6.1. event_route[tm:branch-failure]
144
+
145
+        7. TM Module API
146
+
147
+              7.1. Defines
148
+              7.2. Functions
149
+
150
+                    7.2.1. register_tmcb(cb_type, cb_func)
151
+                    7.2.2. load_tm(*import_structure)
152
+                    7.2.3. int t_suspend(struct sip_msg *msg, unsigned int
140 153
                             *hash_index, unsigned int *label)
141 154
 
142
-                    5.2.4. int t_continue(unsigned int hash_index,
155
+                    7.2.4. int t_continue(unsigned int hash_index,
143 156
                             unsigned int label, struct action *route)
144 157
 
145
-                    5.2.5. int t_cancel_suspend(unsigned int hash_index,
158
+                    7.2.5. int t_cancel_suspend(unsigned int hash_index,
146 159
                             unsigned int label)
147 160
 
148
-        6. Event Routes
149
-
150
-              6.1. event_route[tm:branch-failure]
151
-
152
-        7. Known Issues
161
+        8. Known Issues
153 162
 
154 163
    List of Examples
155 164
 
... ...
@@ -356,27 +365,36 @@ Chapter 1. Admin Guide
356 365
         4.50. t_use_uac_headers()
357 366
         4.51. t_is_retr_async_reply()
358 367
 
359
-   5. TM Module API
368
+   5. RPC Commands
369
+
370
+        5.1. tm.t_uac_start
371
+        5.2. tm.t_uac_wait
372
+        5.3. tm.cancel
373
+        5.4. tm.hash_stats
374
+        5.5. tm.reply
375
+        5.6. tm.reply_callid
360 376
 
361
-        5.1. Defines
362
-        5.2. Functions
377
+   6. Event Routes
363 378
 
364
-              5.2.1. register_tmcb(cb_type, cb_func)
365
-              5.2.2. load_tm(*import_structure)
366
-              5.2.3. int t_suspend(struct sip_msg *msg, unsigned int
379
+        6.1. event_route[tm:branch-failure]
380
+
381
+   7. TM Module API
382
+
383
+        7.1. Defines
384
+        7.2. Functions
385
+
386
+              7.2.1. register_tmcb(cb_type, cb_func)
387
+              7.2.2. load_tm(*import_structure)
388
+              7.2.3. int t_suspend(struct sip_msg *msg, unsigned int
367 389
                       *hash_index, unsigned int *label)
368 390
 
369
-              5.2.4. int t_continue(unsigned int hash_index, unsigned int
391
+              7.2.4. int t_continue(unsigned int hash_index, unsigned int
370 392
                       label, struct action *route)
371 393
 
372
-              5.2.5. int t_cancel_suspend(unsigned int hash_index,
394
+              7.2.5. int t_cancel_suspend(unsigned int hash_index,
373 395
                       unsigned int label)
374 396
 
375
-   6. Event Routes
376
-
377
-        6.1. event_route[tm:branch-failure]
378
-
379
-   7. Known Issues
397
+   8. Known Issues
380 398
 
381 399
 1. Overview
382 400
 
... ...
@@ -2750,20 +2768,120 @@ pended\n");
2750 2768
 }
2751 2769
 ...
2752 2770
 
2753
-5. TM Module API
2771
+5. RPC Commands
2772
+
2773
+   5.1. tm.t_uac_start
2774
+   5.2. tm.t_uac_wait
2775
+   5.3. tm.cancel
2776
+   5.4. tm.hash_stats
2777
+   5.5. tm.reply
2778
+   5.6. tm.reply_callid
2779
+
2780
+5.1.  tm.t_uac_start
2781
+
2782
+   Generates and sends a local SIP request.
2783
+
2784
+   Parameters:
2785
+     * method - request method
2786
+     * RURI - request SIP URI
2787
+     * NEXT HOP - next hop SIP URI (OBP); use “.” if no value.
2788
+     * socket - local socket to be used for sending the request; use “.”
2789
+       if no value.
2790
+     * headers - set of additional headers to be added to the request; at
2791
+       least “From” and “To” headers must be provided)
2792
+     * body - (optional, may not be present) request body (if present,
2793
+       requires the “Content-Type” and “Content-length” headers)
2794
+
2795
+5.2.  tm.t_uac_wait
2796
+
2797
+   Similar to rm.t_uac_start, but waits for the SIP reponse and tries to
2798
+   provide its details via RPC response.
2799
+
2800
+5.3.  tm.cancel
2801
+
2802
+   Generates and sends a CANCEL for an existing local SIP request.
2803
+
2804
+   Parameters:
2805
+     * callid - callid of the INVITE request to be cancelled.
2806
+     * cseq - cseq of the INVITE request to be cancelled.
2807
+
2808
+5.4.  tm.hash_stats
2809
+
2810
+   Gets information about the load of TM internal hash table.
2811
+
2812
+   Parameters:
2813
+     * none
2814
+
2815
+5.5.  tm.reply
2816
+
2817
+   Generates and sends a reply for an existing inbound SIP transaction.
2818
+
2819
+   Parameters:
2820
+     * code - reply code
2821
+     * reason - reason phrase.
2822
+     * trans_id - transaction identifier (has the hash_entry:label format)
2823
+     * to_tag - To tag to be added to TO header
2824
+     * new_headers - extra headers to be appended to the reply; use a dot
2825
+       (“.”) char only if there are no headers;
2826
+     * body - (optional, may not be present) reply body (if present,
2827
+       requires the “Content-Type” and “Content-length” headers)
2828
+
2829
+5.6.  tm.reply_callid
2830
+
2831
+   Generates and sends a reply for an existing inbound SIP transaction.
2832
+
2833
+   Parameters:
2834
+     * code - reply code
2835
+     * reason - reason phrase.
2836
+     * callid - SIP Call-ID header
2837
+     * cseq - SIP CSeq header
2838
+     * to_tag - To tag to be added to TO header
2839
+     * new_headers - extra headers to be appended to the reply; use a dot
2840
+       (“.”) char only if there are no headers;
2841
+     * body - (optional, may not be present) reply body (if present,
2842
+       requires the “Content-Type” and “Content-length” headers)
2843
+
2844
+6. Event Routes
2845
+
2846
+   6.1. event_route[tm:branch-failure]
2847
+
2848
+6.1.  event_route[tm:branch-failure]
2849
+
2850
+   Named branch failure routes can be defined to run when when a failure
2851
+   response is received. This allows handling failures on individual
2852
+   branches, for example, retrying an alternative outbound flow.
2853
+
2854
+   The format of the event_route name is "tm:branch-failure:<name>" and is
2855
+   enabled with the t_on_branch_failure function. This event_route uses
2856
+   the BRANCH_FAILURE_ROUTE route type.
2857
+
2858
+   Example 1.92. event_route[tm:branch-failure] usage
2859
+...
2860
+request_route {
2861
+    ...
2862
+    t_on_branch_failure("myroute");
2863
+    t_relay();
2864
+}
2865
+
2866
+event_route[tm:branch-failure:myroute] {
2867
+    xlog("L_INFO", "Received $T_reply_code to $rm message\n");
2868
+}
2869
+...
2870
+
2871
+7. TM Module API
2754 2872
 
2755
-   5.1. Defines
2756
-   5.2. Functions
2873
+   7.1. Defines
2874
+   7.2. Functions
2757 2875
 
2758
-        5.2.1. register_tmcb(cb_type, cb_func)
2759
-        5.2.2. load_tm(*import_structure)
2760
-        5.2.3. int t_suspend(struct sip_msg *msg, unsigned int
2876
+        7.2.1. register_tmcb(cb_type, cb_func)
2877
+        7.2.2. load_tm(*import_structure)
2878
+        7.2.3. int t_suspend(struct sip_msg *msg, unsigned int
2761 2879
                 *hash_index, unsigned int *label)
2762 2880
 
2763
-        5.2.4. int t_continue(unsigned int hash_index, unsigned int label,
2881
+        7.2.4. int t_continue(unsigned int hash_index, unsigned int label,
2764 2882
                 struct action *route)
2765 2883
 
2766
-        5.2.5. int t_cancel_suspend(unsigned int hash_index, unsigned int
2884
+        7.2.5. int t_cancel_suspend(unsigned int hash_index, unsigned int
2767 2885
                 label)
2768 2886
 
2769 2887
    There are applications which would like to generate SIP transactions
... ...
@@ -2809,7 +2927,7 @@ end of body
2809 2927
 
2810 2928
    or cat test/transaction.fifo > /tmp/ser_fifo
2811 2929
 
2812
-5.1. Defines
2930
+7.1. Defines
2813 2931
 
2814 2932
      * ACK_TAG enables stricter matching of acknowledgments including
2815 2933
        to-tags. Without it, to-tags are ignored. It is disabled by default
... ...
@@ -2828,9 +2946,9 @@ end of body
2828 2946
        ACK_TAG, all this complex transactions matching goes with RFC3261's
2829 2947
        magic cookie away anyway.
2830 2948
 
2831
-5.2. Functions
2949
+7.2. Functions
2832 2950
 
2833
-5.2.1.  register_tmcb(cb_type, cb_func)
2951
+7.2.1.  register_tmcb(cb_type, cb_func)
2834 2952
 
2835 2953
    For programmatic use only--register a function to be called back on an
2836 2954
    event. See t_hooks.h for more details.
... ...
@@ -2839,7 +2957,7 @@ end of body
2839 2957
      * cb_type - Callback type.
2840 2958
      * cb_func - Callback function.
2841 2959
 
2842
-5.2.2.  load_tm(*import_structure)
2960
+7.2.2.  load_tm(*import_structure)
2843 2961
 
2844 2962
    For programmatic use only--import exported TM functions. See the acc
2845 2963
    module for an example of use.
... ...
@@ -2847,7 +2965,7 @@ end of body
2847 2965
    Meaning of the parameters is as follows:
2848 2966
      * import_structure - Pointer to the import structure.
2849 2967
 
2850
-5.2.3.  int t_suspend(struct sip_msg *msg, unsigned int *hash_index, unsigned
2968
+7.2.3.  int t_suspend(struct sip_msg *msg, unsigned int *hash_index, unsigned
2851 2969
 int *label)
2852 2970
 
2853 2971
    For programmatic use only. This function together with t_continue() can
... ...
@@ -2885,7 +3003,7 @@ int *label)
2885 3003
    t_suspend() should return 0 to make sure that the script processing
2886 3004
    does not continue.
2887 3005
 
2888
-5.2.4.  int t_continue(unsigned int hash_index, unsigned int label, struct
3006
+7.2.4.  int t_continue(unsigned int hash_index, unsigned int label, struct
2889 3007
 action *route)
2890 3008
 
2891 3009
    For programmatic use only. This function is the pair of t_suspend(),
... ...
@@ -2901,7 +3019,7 @@ action *route)
2901 3019
 
2902 3020
    Return value: 0 - success, <0 - error.
2903 3021
 
2904
-5.2.5.  int t_cancel_suspend(unsigned int hash_index, unsigned int label)
3022
+7.2.5.  int t_cancel_suspend(unsigned int hash_index, unsigned int label)
2905 3023
 
2906 3024
    For programmatic use only. This function is for revoking t_suspend()
2907 3025
    from the same process as it was executed before. t_cancel_suspend() can
... ...
@@ -2917,33 +3035,7 @@ action *route)
2917 3035
 
2918 3036
    Return value: 0 - success, <0 - error.
2919 3037
 
2920
-6. Event Routes
2921
-
2922
-   6.1. event_route[tm:branch-failure]
2923
-
2924
-6.1.  event_route[tm:branch-failure]
2925
-
2926
-   Named branch failure routes can be defined to run when when a failure
2927
-   response is received. This allows handling failures on individual
2928
-   branches, for example, retrying an alternative outbound flow.
2929
-
2930
-   The format of the event_route name is "tm:branch-failure:<name>" and is
2931
-   enabled with the t_on_branch_failure function. This event_route uses
2932
-   the BRANCH_FAILURE_ROUTE route type.
2933
-
2934
-   Example 1.92. event_route[tm:branch-failure] usage
2935
-...
2936
-route {
2937
-    t_on_branch_failure("myroute");
2938
-    t_relay();
2939
-}
2940
-
2941
-event_route[tm:branch-failure:myroute] {
2942
-    xlog("L_INFO", "Received $T_reply_code to $rm message\n");
2943
-}
2944
-...
2945
-
2946
-7. Known Issues
3038
+8. Known Issues
2947 3039
 
2948 3040
      * Possibly, performance could be improved by not parsing non-INVITEs,
2949 3041
        as they do not be replied with 100, and do not result in
... ...
@@ -38,7 +38,7 @@ Peter Dunkley
38 38
               5.1. ws_handle_handshake()
39 39
               5.2. ws_close([status, reason[, connection_id]])
40 40
 
41
-        6. MI Commands
41
+        6. RPC Commands
42 42
 
43 43
               6.1. ws.dump
44 44
               6.2. ws.close
... ...
@@ -102,7 +102,7 @@ Chapter 1. Admin Guide
102 102
         5.1. ws_handle_handshake()
103 103
         5.2. ws_close([status, reason[, connection_id]])
104 104
 
105
-   6. MI Commands
105
+   6. RPC Commands
106 106
 
107 107
         6.1. ws.dump
108 108
         6.2. ws.close
... ...
@@ -490,7 +490,7 @@ Note
490 490
 ws_close(4000, "Because I say so");
491 491
 ...
492 492
 
493
-6. MI Commands
493
+6. RPC Commands
494 494
 
495 495
    6.1. ws.dump
496 496
    6.2. ws.close
... ...
@@ -512,10 +512,10 @@ Note
512 512
 
513 513
    If no parameter is provided id_hash order is used.
514 514
 
515
-   MI FIFO Command Format:
516
-                        :ws.dump:fifo_reply
517
-                        used_asc
518
-                        _empty_line_
515
+   RPC Command Usage:
516
+...
517
+kamcmd ws.dump used_asc
518
+...
519 519
 
520 520
 6.2. ws.close
521 521
 
... ...
@@ -526,10 +526,10 @@ Note
526 526
    Parameters:
527 527
      * id - WebSocket connection ID.
528 528
 
529
-   MI FIFO Command Format:
530
-                        :ws.close:fifo_reply
531
-                        1
532
-                        _empty_line_
529
+   RPC Command Usage:
530
+...
531
+kamcmd ws.close: 1
532
+...
533 533
 
534 534
 6.3. ws.ping
535 535
 
... ...
@@ -540,10 +540,10 @@ Note
540 540
    Parameters:
541 541
      * id - WebSocket connection ID.
542 542
 
543
-   MI FIFO Command Format:
544
-                        :ws.ping:fifo_reply
545
-                        1
546
-                        _empty_line_
543
+   RPC Command Usage:
544
+...
545
+kamcmd ws.ping 1
546
+...
547 547
 
548 548
 6.4. ws.pong
549 549
 
... ...
@@ -554,10 +554,10 @@ Note
554 554
    Parameters:
555 555
      * id - WebSocket connection ID.
556 556
 
557
-   MI FIFO Command Format:
558
-                        :ws.pong:fifo_reply
559
-                        1
560
-                        _empty_line_
557
+   RPC Command Usage:
558
+...
559
+kamcmd ws.pong 1
560
+...
561 561
 
562 562
 6.5. ws.disable
563 563
 
... ...
@@ -567,9 +567,10 @@ Note
567 567
 
568 568
    Parameters: none
569 569
 
570
-   MI FIFO Command Format:
571
-                        :ws.disable:fifo_reply
572
-                        _empty_line_
570
+   RPC Command Usage:
571
+...
572
+kamcmd ws.disable
573
+...
573 574
 
574 575
 6.6. ws.enable
575 576
 
... ...
@@ -583,9 +584,10 @@ Note
583 584
 
584 585
    Parameters: none
585 586
 
586
-   MI FIFO Command Format:
587
-                        :ws.enable:fifo_reply
588
-                        _empty_line_
587
+   RPC Command Format:
588
+...
589
+kamcmd ws.enable
590
+...
589 591
 
590 592
 7. Event routes
591 593