Browse code

modules: readme files regenerated - cnxcc ...

Kamailio Dev authored on 02/01/2017 13:31:16
Showing 7 changed files
... ...
@@ -32,11 +32,12 @@ Carlos Ruiz Díaz
32 32
               4.4. cnxcc_set_max_channel()
33 33
               4.5. cnxcc_terminate_all()
34 34
 
35
-        5. Exported RPC Commands
35
+        5. RPC Commands
36 36
 
37 37
               5.1. cnxcc.active_clients
38 38
               5.2. cnxcc.check_client
39 39
               5.3. cnxcc.kill_call
40
+              5.4. cnxcc.stats
40 41
 
41 42
         6. Events
42 43
         7. Web Interface
... ...
@@ -76,11 +77,12 @@ Chapter 1. Admin Guide
76 76
         4.4. cnxcc_set_max_channel()
77 77
         4.5. cnxcc_terminate_all()
78 78
 
79
-   5. Exported RPC Commands
79
+   5. RPC Commands
80 80
 
81 81
         5.1. cnxcc.active_clients
82 82
         5.2. cnxcc.check_client
83 83
         5.3. cnxcc.kill_call
84
+        5.4. cnxcc.stats
84 85
 
85 86
    6. Events
86 87
    7. Web Interface
... ...
@@ -283,11 +285,12 @@ if (!cnxcc_terminate_all("$var(customer)")) {
283 283
 }
284 284
 ...
285 285
 
286
-5. Exported RPC Commands
286
+5. RPC Commands
287 287
 
288 288
    5.1. cnxcc.active_clients
289 289
    5.2. cnxcc.check_client
290 290
    5.3. cnxcc.kill_call
291
+   5.4. cnxcc.stats
291 292
 
292 293
 5.1. cnxcc.active_clients
293 294
 
... ...
@@ -316,6 +319,15 @@ if (!cnxcc_terminate_all("$var(customer)")) {
316 316
    Example:
317 317
             kamcmd cnxcc.kill_call qumojlaahitafih@carlosrdcnx-laptop.site
318 318
 
319
+5.4. cnxcc.stats
320
+
321
+   List credit control stats.
322
+
323
+   Parameters: none
324
+
325
+   Example:
326
+            kamcmd cnxcc.stats
327
+
319 328
 6. Events
320 329
 
321 330
    When a call is forced to end an event route is automatically invoked.
... ...
@@ -53,25 +53,22 @@ Ovidiu Sas
53 53
               3.13. resetdebug()
54 54
               3.14. km_append_branch([uri])
55 55
 
56
-        4. MI Commands
56
+        4. RPC Commands
57 57
 
58
-              4.1. arg
59
-              4.2. kill
60
-              4.3. pwd
61
-              4.4. uptime
58
+              4.1. core.arg
59
+              4.2. core.kill
60
+              4.3. core.pwd
61
+              4.4. core.uptime
62 62
               4.5. version
63
-              4.6. which
63
+              4.6. system.listMethods
64 64
               4.7. get_statistics
65
-              4.8. reset_statistics
65
+              4.8. stats.reset_statistics
66 66
               4.9. clear_statistics
67
-
68
-        5. RPC Commands
69
-
70
-              5.1. pkg.stats
71
-              5.2. stats.get_statistics
72
-              5.3. stats.reset_statistics
73
-              5.4. stats.clear_statistics
74
-              5.5. mod.stats module_name/all pkg/shm/all
67
+              4.10. pkg.stats
68
+              4.11. stats.get_statistics
69
+              4.12. stats.reset_statistics
70
+              4.13. stats.clear_statistics
71
+              4.14. mod.stats module_name/all pkg/shm/all
75 72
 
76 73
    List of Examples
77 74
 
... ...
@@ -116,25 +113,22 @@ Chapter 1. Admin Guide
116 116
         3.13. resetdebug()
117 117
         3.14. km_append_branch([uri])
118 118
 
119
-   4. MI Commands
119
+   4. RPC Commands
120 120
 
121
-        4.1. arg
122
-        4.2. kill
123
-        4.3. pwd
124
-        4.4. uptime
121
+        4.1. core.arg
122
+        4.2. core.kill
123
+        4.3. core.pwd
124
+        4.4. core.uptime
125 125
         4.5. version
126
-        4.6. which
126
+        4.6. system.listMethods
127 127
         4.7. get_statistics
128
-        4.8. reset_statistics
128
+        4.8. stats.reset_statistics
129 129
         4.9. clear_statistics
130
-
131
-   5. RPC Commands
132
-
133
-        5.1. pkg.stats
134
-        5.2. stats.get_statistics
135
-        5.3. stats.reset_statistics
136
-        5.4. stats.clear_statistics
137
-        5.5. mod.stats module_name/all pkg/shm/all
130
+        4.10. pkg.stats
131
+        4.11. stats.get_statistics
132
+        4.12. stats.reset_statistics
133
+        4.13. stats.clear_statistics
134
+        4.14. mod.stats module_name/all pkg/shm/all
138 135
 
139 136
 1. Overview
140 137
 
... ...
@@ -401,141 +395,144 @@ resetdebug();
401 401
    This function was replaced by append_branch() from corex module,
402 402
    starting with version 4.0.0.
403 403
 
404
-4. MI Commands
404
+4. RPC Commands
405 405
 
406
-   4.1. arg
407
-   4.2. kill
408
-   4.3. pwd
409
-   4.4. uptime
406
+   4.1. core.arg
407
+   4.2. core.kill
408
+   4.3. core.pwd
409
+   4.4. core.uptime
410 410
    4.5. version
411
-   4.6. which
411
+   4.6. system.listMethods
412 412
    4.7. get_statistics
413
-   4.8. reset_statistics
413
+   4.8. stats.reset_statistics
414 414
    4.9. clear_statistics
415
+   4.10. pkg.stats
416
+   4.11. stats.get_statistics
417
+   4.12. stats.reset_statistics
418
+   4.13. stats.clear_statistics
419
+   4.14. mod.stats module_name/all pkg/shm/all
415 420
 
416
-4.1.  arg
421
+4.1.  core.arg
417 422
 
418 423
    Print command line arguments.
419 424
 
420
-   Name: arg
425
+   Name: core.arg
421 426
 
422 427
    Parameters: none.
423 428
 
424
-   MI FIFO Command Format:
425
-                :arg:_reply_fifo_file_
426
-                _empty_line_
429
+   RPC Command Format:
430
+...
431
+kamcmd core.arg
432
+...
427 433
 
428
-4.2.  kill
434
+4.2.  core.kill
429 435
 
430 436
    Kill the application.
431 437
 
432
-   Name: kill
438
+   Name: core.kill
433 439
 
434 440
    Parameters: none.
435 441
 
436
-   MI FIFO Command Format:
437
-                :kill:_reply_fifo_file_
438
-                _empty_line_
442
+   RPC Command Format:
443
+...
444
+kamcmd core.kill
445
+...
439 446
 
440
-4.3.  pwd
447
+4.3.  core.pwd
441 448
 
442 449
    Print working directory.
443 450
 
444
-   Name: pwd
451
+   Name: core.pwd
445 452
 
446 453
    Parameters: none.
447 454
 
448
-   MI FIFO Command Format:
449
-                :pwd:_reply_fifo_file_
450
-                _empty_line_
455
+   RPC Command Format:
456
+...
457
+kamcmd core.pwd
458
+...
451 459
 
452
-4.4.  uptime
460
+4.4.  core.uptime
453 461
 
454 462
    Print uptime.
455 463
 
456
-   Name: uptime
464
+   Name: core.uptime
457 465
 
458 466
    Parameters: none.
459 467
 
460
-   MI FIFO Command Format:
461
-                :uptime:_reply_fifo_file_
462
-                _empty_line_
468
+   RPC Command Format:
469
+...
470
+kamcmd core.uptime
471
+...
463 472
 
464 473
 4.5.  version
465 474
 
466 475
    Print version information.
467 476
 
468
-   Name: version
477
+   Name: core.version
469 478
 
470 479
    Parameters: none.
471 480
 
472
-   MI FIFO Command Format:
473
-                :version:_reply_fifo_file_
474
-                _empty_line_
481
+   RPC Command Format:
482
+...
483
+kamcmd core.version
484
+...
475 485
 
476
-4.6.  which
486
+4.6.  system.listMethods
477 487
 
478
-   Print list of available MI commands.
488
+   Print list of available RPC commands.
479 489
 
480 490
    Name: which
481 491
 
482 492
    Parameters: none.
483 493
 
484
-   MI FIFO Command Format:
485
-                :which:_reply_fifo_file_
486
-                _empty_line_
494
+   RPC Command Format:
495
+...
496
+kamcmd system.listMethods
497
+...
487 498
 
488 499
 4.7.  get_statistics
489 500
 
490 501
    Print the list of available internal statistics.
491 502
 
492
-   Name: get_statistics
503
+   Name: stats.get_statistics
493 504
 
494 505
    Parameters: statsid - which statistics to be printed. If set to 'all'
495 506
    then all statistics are printed; if set to 'statsgroup:' then all
496 507
    statistics in the group are printed; if set to 'statsname' then the
497 508
    statistics identified by the name is printed.
498 509
 
499
-   MI FIFO Command Format:
500
-                :get_statistics:_reply_fifo_file_
501
-                _statsid_
502
-                _empty_line_
510
+   RPC Command Format:
511
+...
512
+kamcmd stats.get_statistics
513
+...
503 514
 
504
-4.8.  reset_statistics
515
+4.8.  stats.reset_statistics
505 516
 
506 517
    Reset internal statistics.
507 518
 
508
-   Name: reset_statistics
519
+   Name: statsreset_statistics
509 520
 
510 521
    Parameters: statsid - which statistics to be reset, give as name.
511 522
 
512
-   MI FIFO Command Format:
513
-                :reset_statistics:_reply_fifo_file_
514
-                _statsid_
515
-                _empty_line_
523
+   RPC Command Format:
524
+...
525
+kamcmd reset_statistics _statsid_
526
+...
516 527
 
517 528
 4.9.  clear_statistics
518 529
 
519 530
    Return statistics and reset their value in one command.
520 531
 
521
-   Name: get_statistics
532
+   Name: stats.get_statistics
522 533
 
523 534
    Parameters: statsid - same as for get_statistics.
524 535
 
525
-   MI FIFO Command Format:
526
-                :clear_statistics:_reply_fifo_file_
527
-                _statsid_
528
-                _empty_line_
529
-
530
-5. RPC Commands
531
-
532
-   5.1. pkg.stats
533
-   5.2. stats.get_statistics
534
-   5.3. stats.reset_statistics
535
-   5.4. stats.clear_statistics
536
-   5.5. mod.stats module_name/all pkg/shm/all
536
+   RPC Command Format:
537
+...
538
+kamcmd clear_statistics _statsid_
539
+...
537 540
 
538
-5.1.  pkg.stats
541
+4.10.  pkg.stats
539 542
 
540 543
    Print private memory (pkg) usage statistics per process. It can take
541 544
    optinally a filter to print statistics only for a specific process or
... ...
@@ -553,7 +550,7 @@ resetdebug();
553 553
                 kamcmd pkg.stats rank 1
554 554
                 kamcmd pkg.stats index 10
555 555
 
556
-5.2.  stats.get_statistics
556
+4.11.  stats.get_statistics
557 557
 
558 558
    Print the list of available internal statistics.
559 559
 
... ...
@@ -568,7 +565,7 @@ resetdebug();
568 568
                 kamcmd stats.get_statistics unsupported_methods
569 569
                 kamcmd stats.get_statistics shmem: fwd_requests fwd_replies
570 570
 
571
-5.3.  stats.reset_statistics
571
+4.12.  stats.reset_statistics
572 572
 
573 573
    Reset internal statistics.
574 574
 
... ...
@@ -580,7 +577,7 @@ resetdebug();
580 580
                 kamcmd stats.reset_statistics unsupported_methods
581 581
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
582 582
 
583
-5.4.  stats.clear_statistics
583
+4.13.  stats.clear_statistics
584 584
 
585 585
    Return statistics and reset their value in one command.
586 586
 
... ...
@@ -592,7 +589,7 @@ resetdebug();
592 592
                 kamcmd stats.reset_statistics unsupported_methods
593 593
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
594 594
 
595
-5.5.  mod.stats module_name/all pkg/shm/all
595
+4.14.  mod.stats module_name/all pkg/shm/all
596 596
 
597 597
    Print private(pkg) or shared(shm) memory currently allocated a given
598 598
    module or by all modules.
... ...
@@ -626,7 +623,7 @@ Module: kex
626 626
     // this is the pkg zone of the module
627 627
     // function_name(line_where_pkg_malloc_was_called): size_alloc'ed_by_pkg_mal
628 628
 loc
629
-    init_mi_uptime(74): 56
629
+    init_rpc_uptime(74): 56
630 630
     Total: 56
631 631
 }
632 632
 {
... ...
@@ -1,193 +1,2 @@
1
-mqueue Module
2 1
 
3
-Elena-Ramona Modroiu
4 2
 
5
-   asipto.com
6
-
7
-Edited by
8
-
9
-Elena-Ramona Modroiu
10
-
11
-   <ramona@asipto.com>
12
-
13
-Edited by
14
-
15
-Alex Balashov
16
-
17
-   Evariste Systems
18
-   <abalashov@evaristesys.com>
19
-
20
-   Copyright © 2010 Elena-Ramona Modroiu (asipto.com)
21
-     __________________________________________________________________
22
-
23
-   Table of Contents
24
-
25
-   1. Admin Guide
26
-
27
-        1. Overview
28
-        2. Dependencies
29
-
30
-              2.1. Kamailio Modules
31
-              2.2. External Libraries or Applications
32
-
33
-        3. Parameters
34
-
35
-              3.1. mqueue (string)
36
-
37
-        4. Functions
38
-
39
-              4.1. mq_add(queue, key, value)
40
-              4.2. mq_fetch(queue)
41
-              4.3. mq_pv_free(queue)
42
-              4.4. mq_size(queue)
43
-
44
-        5. Exported Pseudo-variables
45
-
46
-   List of Examples
47
-
48
-   1.1. Set mqueue parameter
49
-   1.2. mq_add usage
50
-   1.3. mq_fetch usage
51
-   1.4. mq_pv_free usage
52
-   1.5. mq_size usage
53
-
54
-Chapter 1. Admin Guide
55
-
56
-   Table of Contents
57
-
58
-   1. Overview
59
-   2. Dependencies
60
-
61
-        2.1. Kamailio Modules
62
-        2.2. External Libraries or Applications
63
-
64
-   3. Parameters
65
-
66
-        3.1. mqueue (string)
67
-
68
-   4. Functions
69
-
70
-        4.1. mq_add(queue, key, value)
71
-        4.2. mq_fetch(queue)
72
-        4.3. mq_pv_free(queue)
73
-        4.4. mq_size(queue)
74
-
75
-   5. Exported Pseudo-variables
76
-
77
-1. Overview
78
-
79
-   The mqueue module offers a generic message queue system in shared
80
-   memory for inter-process communication using the config file. One
81
-   example of usage is to send time consuming operations to one or several
82
-   timer processes that consumes items in the queue, without affecting SIP
83
-   message handling in the socket-listening process.
84
-
85
-   There can be many defined queues. Access to queued values is done via
86
-   pseudo variables.
87
-
88
-2. Dependencies
89
-
90
-   2.1. Kamailio Modules
91
-   2.2. External Libraries or Applications
92
-
93
-2.1. Kamailio Modules
94
-
95
-   The following modules must be loaded before this module:
96
-     * None.
97
-
98
-2.2. External Libraries or Applications
99
-
100
-   The following libraries or applications must be installed before
101
-   running Kamailio with this module loaded:
102
-     * None.
103
-
104
-3. Parameters
105
-
106
-   3.1. mqueue (string)
107
-
108
-3.1. mqueue (string)
109
-
110
-   Definition of a memory queue
111
-
112
-   Default value is “none”.
113
-
114
-   Value must be a list of parameters: attr=value;... The attribute 'name'
115
-   is mandatory, defining the name of the queue. Optional attribute 'size'
116
-   specifies the maximum number of items in queue, if it is execeeded the
117
-   oldest one is removed.
118
-
119
-   The parameter can be set many times, each holding the definition of one
120
-   queue.
121
-
122
-   Example 1.1. Set mqueue parameter
123
-...
124
-modparam("mqueue", "mqueue", "name=myq;size=20;")
125
-modparam("mqueue", "mqueue", "name=qaz")
126
-...
127
-
128
-4. Functions
129
-
130
-   4.1. mq_add(queue, key, value)
131
-   4.2. mq_fetch(queue)
132
-   4.3. mq_pv_free(queue)
133
-   4.4. mq_size(queue)
134
-
135
-4.1.  mq_add(queue, key, value)
136
-
137
-   Add a new item (key, value) in the queue. If max size of queue is
138
-   exceeded, the oldest one is removed.
139
-
140
-   Example 1.2. mq_add usage
141
-...
142
-mq_add("myq", "$rU", "call from $fU");
143
-...
144
-
145
-4.2.  mq_fetch(queue)
146
-
147
-   Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo
148
-   variables.
149
-
150
-   Return: true on success (1); false on failure (-1) or no item fetched
151
-   (-2).
152
-
153
-   Example 1.3. mq_fetch usage
154
-...
155
-while(mq_fetch("myq"))
156
-{
157
-   xlog("$mqk(myq) - $mqv(myq)\n");
158
-}
159
-...
160
-
161
-4.3.  mq_pv_free(queue)
162
-
163
-   Free the item fetched in pseudo-variables. It is optional, a new fetch
164
-   frees the previous values.
165
-
166
-   Example 1.4. mq_pv_free usage
167
-...
168
-mq_pv_free("myq");
169
-...
170
-
171
-4.4.  mq_size(queue)
172
-
173
-   Returns the current number of elements in the mqueue.
174
-
175
-   If the mqueue is empty, the function returns -1. If the mqueue is not
176
-   found, the function returns -2.
177
-
178
-   Example 1.5. mq_size usage
179
-...
180
-$var(q_size) = mq_size("queue");
181
-xlog("L_INFO", "Size of queue is: $var(q_size)\n");
182
-...
183
-
184
-5. Exported Pseudo-variables
185
-
186
-     * $mqv(mqueue) - the most recent item key fetched from the specified
187
-       mqueue
188
-     * $mqv(mqueue) - the most recent item value fetched from the
189
-       specified mqueue
190
-     * $mq_size(mqueue) - the size of the specified mqueue
191
-
192
-   Exported pseudo-variables are documented at
193
-   http://www.kamailio.org/wiki/.
... ...
@@ -26,9 +26,6 @@ Peter Dunkley
26 26
               3.1. force_outbound_flag (integer)
27 27
               3.2. force_no_outbound_flag (integer)
28 28
 
29
-        4. Functions
30
-        5. MI Commands
31
-
32 29
    List of Examples
33 30
 
34 31
    1.1. Edge Proxy Configuration
... ...
@@ -55,9 +52,6 @@ Chapter 1. Admin Guide
55 55
         3.1. force_outbound_flag (integer)
56 56
         3.2. force_no_outbound_flag (integer)
57 57
 
58
-   4. Functions
59
-   5. MI Commands
60
-
61 58
 1. Overview
62 59
 
63 60
    1.1. Edge Proxy Keep-Alives (STUN)
... ...
@@ -522,11 +516,3 @@ modparam("outbound", "force_outbound_flag", 1)
522 522
 ...
523 523
 modparam("outbound", "force_no_outbound_flag", 2)
524 524
 ...
525
-
526
-4. Functions
527
-
528
-   None
529
-
530
-5. MI Commands
531
-
532
-   None
... ...
@@ -49,23 +49,14 @@ Daniel-Constantin Mierla
49 49
               4.1. pl_check(name [, algorithm, limit])
50 50
               4.2. pl_drop([ [min ], max ])
51 51
 
52
-        5. MI Commands
52
+        5. RPC Commands
53 53
 
54
-              5.1. pl_stats
55
-              5.2. pl_set_pipe
56
-              5.3. pl_get_pipes
57
-              5.4. pl_set_pid
58
-              5.5. pl_get_pid
59
-              5.6. pl_push_load
60
-
61
-        6. RPC Commands
62
-
63
-              6.1. pl.stats
64
-              6.2. pl.set_pipe
65
-              6.3. pl.get_pipes
66
-              6.4. pl.set_pid
67
-              6.5. pl.get_pid
68
-              6.6. pl.push_load
54
+              5.1. pl.stats
55
+              5.2. pl.set_pipe
56
+              5.3. pl.get_pipes
57
+              5.4. pl.set_pid
58
+              5.5. pl.get_pid
59
+              5.6. pl.push_load
69 60
 
70 61
    List of Examples
71 62
 
... ...
@@ -113,23 +104,14 @@ Chapter 1. Admin Guide
113 113
         4.1. pl_check(name [, algorithm, limit])
114 114
         4.2. pl_drop([ [min ], max ])
115 115
 
116
-   5. MI Commands
117
-
118
-        5.1. pl_stats
119
-        5.2. pl_set_pipe
120
-        5.3. pl_get_pipes
121
-        5.4. pl_set_pid
122
-        5.5. pl_get_pid
123
-        5.6. pl_push_load
124
-
125
-   6. RPC Commands
116
+   5. RPC Commands
126 117
 
127
-        6.1. pl.stats
128
-        6.2. pl.set_pipe
129
-        6.3. pl.get_pipes
130
-        6.4. pl.set_pid
131
-        6.5. pl.get_pid
132
-        6.6. pl.push_load
118
+        5.1. pl.stats
119
+        5.2. pl.set_pipe
120
+        5.3. pl.get_pipes
121
+        5.4. pl.set_pid
122
+        5.5. pl.get_pid
123
+        5.6. pl.push_load
133 124
 
134 125
 1. Overview
135 126
 
... ...
@@ -449,113 +431,16 @@ with unexpected retcode=$var(check_result)\n");
449 449
         }
450 450
 ...
451 451
 
452
-5. MI Commands
453
-
454
-   5.1. pl_stats
455
-   5.2. pl_set_pipe
456
-   5.3. pl_get_pipes
457
-   5.4. pl_set_pid
458
-   5.5. pl_get_pid
459
-   5.6. pl_push_load
460
-
461
-5.1.  pl_stats
462
-
463
-   Lists the parameters and variables in the pipelimit module.
464
-
465
-   Name: pl_stats
466
-
467
-   Parameters: none
468
-
469
-   MI FIFO Command Format:
470
-                :pl_stats:_reply_fifo_file_
471
-                _empty_line_
472
-
473
-5.2.  pl_set_pipe
474
-
475
-   Sets the pipe parameters for the given pipe id.
476
-
477
-   Name: pl_set_pipe
478
-
479
-   Parameters:
480
-     * pipe_id - pipe id.
481
-     * pipe_algorithm - the algorithm assigned to the given pipe id.
482
-     * pipe_limit - the limit assigned to the given pipe id.
483
-
484
-   MI FIFO Command Format:
485
-                :pl_set_pipe:_reply_fifo_file_
486
-                2
487
-                RED
488
-                10
489
-                _empty_line_
490
-
491
-5.3.  pl_get_pipes
492
-
493
-   Gets the list of in use pipes.
494
-
495
-   Name: pl_get_pipes
496
-
497
-   Parameters: none
498
-
499
-   MI FIFO Command Format:
500
-                :pl_get_pipes:_reply_fifo_file_
501
-                _empty_line_
502
-
503
-5.4.  pl_set_pid
504
-
505
-   Sets the PID Controller parameters for the Feedback Algorithm.
506
-
507
-   Name: pl_set_pid
508
-
509
-   Parameters:
510
-     * ki - the integral parameter.
511
-     * kp - the proportional parameter.
512
-     * kd - the derivative parameter.
513
-
514
-   MI FIFO Command Format:
515
-                :pl_set_pid:_reply_fifo_file_
516
-                0.5
517
-                0.5
518
-                0.5
519
-                _empty_line_
520
-
521
-5.5.  pl_get_pid
522
-
523
-   Gets the list of in use PID Controller parameters.
524
-
525
-   Name: pl_get_pid
526
-
527
-   Parameters: none
528
-
529
-   MI FIFO Command Format:
530
-                :pl_get_pid:_reply_fifo_file_
531
-                _empty_line_
532
-
533
-5.6.  pl_push_load
534
-
535
-   Force the value of the load parameter. This command is useful for
536
-   testing the Feedback algorithm.
537
-
538
-   Name: pl_push_load
539
-
540
-   Parameters:
541
-     * load - the forced value of load (it must be greater then 0.0 and
542
-       smaller then 1.0).
543
-
544
-   MI FIFO Command Format:
545
-                :pl_push_load:_reply_fifo_file_
546
-                0.85
547
-                _empty_line_
548
-
549
-6. RPC Commands
452
+5. RPC Commands
550 453
 
551
-   6.1. pl.stats
552
-   6.2. pl.set_pipe
553
-   6.3. pl.get_pipes
554
-   6.4. pl.set_pid
555
-   6.5. pl.get_pid
556
-   6.6. pl.push_load
454
+   5.1. pl.stats
455
+   5.2. pl.set_pipe
456
+   5.3. pl.get_pipes
457
+   5.4. pl.set_pid
458
+   5.5. pl.get_pid
459
+   5.6. pl.push_load
557 460
 
558
-6.1.  pl.stats
461
+5.1.  pl.stats
559 462
 
560 463
    Lists the parameters and variabiles in the pipelimit module: pipe id,
561 464
    pipe load and pipe couter.
... ...
@@ -567,7 +452,7 @@ with unexpected retcode=$var(check_result)\n");
567 567
    RPC Command Format:
568 568
         kamcmd pl.stats
569 569
 
570
-6.2.  pl.set_pipe
570
+5.2.  pl.set_pipe
571 571
 
572 572
    Sets the pipe parameters for the given pipe id.
573 573
 
... ...
@@ -581,7 +466,7 @@ with unexpected retcode=$var(check_result)\n");
581 581
    RPC Command Format:
582 582
         kamcmd pl.set_pipe 2 RED 10
583 583
 
584
-6.3.  pl.get_pipes
584
+5.3.  pl.get_pipes
585 585
 
586 586
    Gets the list of in use pipes.
587 587
 
... ...
@@ -592,7 +477,7 @@ with unexpected retcode=$var(check_result)\n");
592 592
    RPC Command Format:
593 593
         kamcmd pl.get_pipes
594 594
 
595
-6.4.  pl.set_pid
595
+5.4.  pl.set_pid
596 596
 
597 597
    Sets the PID Controller parameters for the Feedback Algorithm.
598 598
 
... ...
@@ -606,7 +491,7 @@ with unexpected retcode=$var(check_result)\n");
606 606
    RPC Command Format:
607 607
         kamcmd pl.set_pid 0.5 0.5 0.5
608 608
 
609
-6.5.  pl.get_pid
609
+5.5.  pl.get_pid
610 610
 
611 611
    Gets the list of in use PID Controller parameters.
612 612
 
... ...
@@ -617,7 +502,7 @@ with unexpected retcode=$var(check_result)\n");
617 617
    RPC Command Format:
618 618
         kamcmd pl.get_pid
619 619
 
620
-6.6.  pl.push_load
620
+5.6.  pl.push_load
621 621
 
622 622
    Force the value of the load parameter. This command is useful for
623 623
    testing the Feedback algorithm.
... ...
@@ -55,16 +55,12 @@ Alexandr Dubovikov
55 55
               4.1. sip_capture([table])
56 56
               4.2. report_capture([table],[data])
57 57
 
58
-        5. MI Commands
58
+        5. RPC Commands
59 59
 
60
-              5.1. sip_capture
60
+              5.1. sipcapture.status param
61 61
 
62
-        6. RPC Commands
63
-
64
-              6.1. sipcapture.status param
65
-
66
-        7. Database setup
67
-        8. Limitations
62
+        6. Database setup
63
+        7. Limitations
68 64
 
69 65
    List of Examples
70 66
 
... ...
@@ -129,16 +125,12 @@ Chapter 1. Admin Guide
129 129
         4.1. sip_capture([table])
130 130
         4.2. report_capture([table],[data])
131 131
 
132
-   5. MI Commands
133
-
134
-        5.1. sip_capture
135
-
136
-   6. RPC Commands
132
+   5. RPC Commands
137 133
 
138
-        6.1. sipcapture.status param
134
+        5.1. sipcapture.status param
139 135
 
140
-   7. Database setup
141
-   8. Limitations
136
+   6. Database setup
137
+   7. Limitations
142 138
 
143 139
 1. Overview
144 140
 
... ...
@@ -513,33 +505,11 @@ report_capture("report_data");
513 513
 report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
514 514
 ...
515 515
 
516
-5. MI Commands
517
-
518
-   5.1. sip_capture
519
-
520
-5.1.  sip_capture
521
-
522
-   Name: sip_capture
523
-
524
-   Parameters:
525
-     * capture_mode : turns on/off SIP message capturing. Possible values
526
-       are:
527
-          + on
528
-          + off
529
-       The parameter is optional - if missing, the command will return the
530
-       status of the SIP message capturing (as string “on” or “off” )
531
-       without changing anything.
532
-
533
-   MI FIFO Command Format:
534
-                :sip_capture:_reply_fifo_file_
535
-                capture_mode
536
-                _empty_line_
516
+5. RPC Commands
537 517
 
538
-6. RPC Commands
518
+   5.1. sipcapture.status param
539 519
 
540
-   6.1. sipcapture.status param
541
-
542
-6.1.  sipcapture.status param
520
+5.1.  sipcapture.status param
543 521
 
544 522
    Name: sipcapture.status
545 523
 
... ...
@@ -550,7 +520,14 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
550 550
      * “check” does not change sipcapture status, just reports the current
551 551
        status.
552 552
 
553
-7. Database setup
553
+   RPC Command Format:
554
+...
555
+kamcmd sipcapture.status on
556
+kamcmd sipcapture.status off
557
+kamcmd sipcapture.status check
558
+...
559
+
560
+6. Database setup
554 561
 
555 562
    Before running Kamailio with the sipcapture module, you have to setup
556 563
    the database tables where the module will store the data. For that, if
... ...
@@ -560,7 +537,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
560 560
    find the complete database documentation on the project webpage,
561 561
    http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
562 562
 
563
-8. Limitations
563
+7. Limitations
564 564
 
565 565
      * 1. Only one capturing mode on RAW socket is supported: IPIP or
566 566
        monitoring/mirroring port. Don't activate both at the same time.
... ...
@@ -56,16 +56,12 @@ Daniel-Constantin Mierla
56 56
 
57 57
               4.1. sip_trace([address])
58 58
 
59
-        5. MI Commands
59
+        5. RPC Commands
60 60
 
61
-              5.1. sip_trace
61
+              5.1. siptrace.status param
62 62
 
63
-        6. RPC Commands
64
-
65
-              6.1. siptrace.status param
66
-
67
-        7. Database setup
68
-        8. Known issues
63
+        6. Database setup
64
+        7. Known issues
69 65
 
70 66
    List of Examples
71 67
 
... ...
@@ -124,16 +120,12 @@ Chapter 1. Admin Guide
124 124
 
125 125
         4.1. sip_trace([address])
126 126
 
127
-   5. MI Commands
128
-
129
-        5.1. sip_trace
130
-
131
-   6. RPC Commands
127
+   5. RPC Commands
132 128
 
133
-        6.1. siptrace.status param
129
+        5.1. siptrace.status param
134 130
 
135
-   7. Database setup
136
-   8. Known issues
131
+   6. Database setup
132
+   7. Known issues
137 133
 
138 134
 1. Overview
139 135
 
... ...
@@ -465,32 +457,11 @@ sip_trace();
465 465
 sip_trace("sip:10.1.1.2:5085");
466 466
 ...
467 467
 
468
-5. MI Commands
469
-
470
-   5.1. sip_trace
471
-
472
-5.1.  sip_trace
473
-
474
-   Name: sip_trace
475
-
476
-   Parameters:
477
-     * trace_mode : turns on/off SIP message tracing. Possible values are:
478
-          + on
479
-          + off
480
-       The parameter is optional - if missing, the command will return the
481
-       status of the SIP message tracing (as string “on” or “off” )
482
-       without changing anything.
483
-
484
-   MI FIFO Command Format:
485
-                :sip_trace:_reply_fifo_file_
486
-                trace_mode
487
-                _empty_line_
468
+5. RPC Commands
488 469
 
489
-6. RPC Commands
470
+   5.1. siptrace.status param
490 471
 
491
-   6.1. siptrace.status param
492
-
493
-6.1.  siptrace.status param
472
+5.1.  siptrace.status param
494 473
 
495 474
    Name: siptrace.status
496 475
 
... ...
@@ -501,7 +472,14 @@ sip_trace("sip:10.1.1.2:5085");
501 501
      * “check” does not change siptrace status, just reports the current
502 502
        status.
503 503
 
504
-7. Database setup
504
+   RPC Command Format:
505
+...
506
+kamcmd siptrace.status on
507
+kamcmd siptrace.status off
508
+kamcmd siptrace.status check
509
+...
510
+
511
+6. Database setup
505 512
 
506 513
    Before running Kamailio with siptrace, you have to setup the database
507 514
    tables where the module will store the data. For that, if the table
... ...
@@ -511,7 +489,7 @@ sip_trace("sip:10.1.1.2:5085");
511 511
    You can also find the complete database documentation on the project
512 512
    webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
513 513
 
514
-8. Known issues
514
+7. Known issues
515 515
 
516 516
    Stateless forwarded messages (forward()) are not logged if you set the
517 517
    flag, use sip_trace().