Browse code

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

Kamailio Dev authored on 19/12/2018 13:16:41
Showing 1 changed files
... ...
@@ -34,6 +34,8 @@ Peter Dunkley
34 34
               4.7. cors_mode (integer)
35 35
               4.8. verbose_list (int)
36 36
               4.9. event_callback (str)
37
+              4.10. timer_interval (integer)
38
+              4.11. rm_delay_interval (integer)
37 39
 
38 40
         5. Functions
39 41
 
... ...
@@ -70,10 +72,12 @@ Peter Dunkley
70 72
    1.9. Set cors_mode parameter
71 73
    1.10. Set verbose_list parameter
72 74
    1.11. Set event_callback parameter
73
-   1.12. ws_handle_handshake usage
74
-   1.13. ws_close usage
75
-   1.14. event_route[websocket:closed] usage
76
-   1.15. $ws_conid usage
75
+   1.12. Set timer_intervalparameter
76
+   1.13. Set rm_timer_intervalparameter
77
+   1.14. ws_handle_handshake usage
78
+   1.15. ws_close usage
79
+   1.16. event_route[websocket:closed] usage
80
+   1.17. $ws_conid usage
77 81
 
78 82
 Chapter 1. Admin Guide
79 83
 
... ...
@@ -102,6 +106,8 @@ Chapter 1. Admin Guide
102 106
         4.7. cors_mode (integer)
103 107
         4.8. verbose_list (int)
104 108
         4.9. event_callback (str)
109
+        4.10. timer_interval (integer)
110
+        4.11. rm_delay_interval (integer)
105 111
 
106 112
    5. Functions
107 113
 
... ...
@@ -345,6 +351,8 @@ onreply_route[WS_REPLY] {
345 351
    4.7. cors_mode (integer)
346 352
    4.8. verbose_list (int)
347 353
    4.9. event_callback (str)
354
+   4.10. timer_interval (integer)
355
+   4.11. rm_delay_interval (integer)
348 356
 
349 357
 4.1. keepalive_mechanism (integer)
350 358
 
... ...
@@ -483,6 +491,29 @@ function ksr_websocket_event(evname)
483 491
 end
484 492
 ...
485 493
 
494
+4.10. timer_interval (integer)
495
+
496
+   The number of seconds between each timer process run
497
+
498
+   Default value is 1.
499
+
500
+   Example 1.12. Set timer_intervalparameter
501
+...
502
+modparam("websocket", "timer_interval", 5)
503
+...
504
+
505
+4.11. rm_delay_interval (integer)
506
+
507
+   The number of seconds to wait before destroying the websocket
508
+   connection once put in remove state.
509
+
510
+   Default value is 5.
511
+
512
+   Example 1.13. Set rm_timer_intervalparameter
513
+...
514
+modparam("websocket", "rm_delay_interval", 2)
515
+...
516
+
486 517
 5. Functions
487 518
 
488 519
    5.1. ws_handle_handshake()
... ...
@@ -503,7 +534,7 @@ Note
503 534
    request, when there is a problem. Otherwise, it returns 1 (or positive
504 535
    number) in case of success.
505 536
 
506
-   Example 1.12. ws_handle_handshake usage
537
+   Example 1.14. ws_handle_handshake usage
507 538
 ...
508 539
 ws_handle_handshake();
509 540
 ...
... ...
@@ -528,7 +559,7 @@ Note
528 559
 
529 560
    This function can be used from ANY_ROUTE.
530 561
 
531
-   Example 1.13. ws_close usage
562
+   Example 1.15. ws_close usage
532 563
 ...
533 564
 ws_close(4000, "Because I say so");
534 565
 ...
... ...
@@ -642,7 +673,7 @@ kamcmd ws.enable
642 673
    connection closes. The connection may be identified using the the $si
643 674
    and $sp pseudo-variables.
644 675
 
645
-   Example 1.14. event_route[websocket:closed] usage
676
+   Example 1.16. event_route[websocket:closed] usage
646 677
 ...
647 678
 event_route[websocket:closed] {
648 679
         xlog("L_INFO", "WebSocket connection from $si:$sp has closed\n");
... ...
@@ -658,7 +689,7 @@ event_route[websocket:closed] {
658 689
    Connection id of closed websocket connection. Can only be used in
659 690
    websocket:closed event route.
660 691
 
661
-   Example 1.15. $ws_conid usage
692
+   Example 1.17. $ws_conid usage
662 693
 ...
663 694
 event_route[websocket:closed] {
664 695
         xlog("L_INFO", "WebSocket connection with id $ws_conid has closed\n");