Browse code

modules: readme files regenerated - websocket ...

Kamailio Dev authored on 31/01/2017 11:31:15
Showing 1 changed files
... ...
@@ -32,6 +32,7 @@ Peter Dunkley
32 32
               4.5. ping_application_data (string)
33 33
               4.6. sub_protocols (integer)
34 34
               4.7. cors_mode (integer)
35
+              4.8. verbose_list (int)
35 36
 
36 37
         5. Functions
37 38
 
... ...
@@ -66,10 +67,11 @@ Peter Dunkley
66 67
    1.7. Set ping_application_data parameter
67 68
    1.8. Set sub_protocols parameter
68 69
    1.9. Set cors_mode parameter
69
-   1.10. ws_handle_handshake usage
70
-   1.11. ws_close usage
71
-   1.12. event_route[websocket:closed] usage
72
-   1.13. $ws_conid usage
70
+   1.10. Set verbose_list parameter
71
+   1.11. ws_handle_handshake usage
72
+   1.12. ws_close usage
73
+   1.13. event_route[websocket:closed] usage
74
+   1.14. $ws_conid usage
73 75
 
74 76
 Chapter 1. Admin Guide
75 77
 
... ...
@@ -96,6 +98,7 @@ Chapter 1. Admin Guide
96 98
         4.5. ping_application_data (string)
97 99
         4.6. sub_protocols (integer)
98 100
         4.7. cors_mode (integer)
101
+        4.8. verbose_list (int)
99 102
 
100 103
    5. Functions
101 104
 
... ...
@@ -337,6 +340,7 @@ onreply_route[WS_REPLY] {
337 340
    4.5. ping_application_data (string)
338 341
    4.6. sub_protocols (integer)
339 342
    4.7. cors_mode (integer)
343
+   4.8. verbose_list (int)
340 344
 
341 345
 4.1. keepalive_mechanism (integer)
342 346
 
... ...
@@ -440,6 +444,19 @@ modparam("websocket", "sub_protocols", 2)
440 444
 modparam("websocket", "cors_mode", 2)
441 445
 ...
442 446
 
447
+4.8. verbose_list (int)
448
+
449
+   Allows to enable/disable the printing of debug messages when getting
450
+   the list of websocket connections. If enabled, it prints debug messages
451
+   every second for ping operations.
452
+
453
+   Default value is 0 (disabled).
454
+
455
+   Example 1.10. Set verbose_list parameter
456
+...
457
+modparam("websocket", "verbose_list", 1)
458
+...
459
+
443 460
 5. Functions
444 461
 
445 462
    5.1. ws_handle_handshake()
... ...
@@ -459,7 +476,7 @@ Note
459 476
    This function returns 0, stopping all further processing of the
460 477
    request, when there is a problem.
461 478
 
462
-   Example 1.10. ws_handle_handshake usage
479
+   Example 1.11. ws_handle_handshake usage
463 480
 ...
464 481
 ws_handle_handshake();
465 482
 ...
... ...
@@ -484,7 +501,7 @@ Note
484 501
 
485 502
    This function can be used from ANY_ROUTE.
486 503
 
487
-   Example 1.11. ws_close usage
504
+   Example 1.12. ws_close usage
488 505
 ...
489 506
 ws_close(4000, "Because I say so");
490 507
 ...
... ...
@@ -598,7 +615,7 @@ kamcmd ws.enable
598 615
    connection closes. The connection may be identified using the the $si
599 616
    and $sp pseudo-variables.
600 617
 
601
-   Example 1.12. event_route[websocket:closed] usage
618
+   Example 1.13. event_route[websocket:closed] usage
602 619
 ...
603 620
 event_route[websocket:closed] {
604 621
         xlog("L_INFO", "WebSocket connection from $si:$sp has closed\n");
... ...
@@ -614,7 +631,7 @@ event_route[websocket:closed] {
614 631
    Connection id of closed websocket connection. Can only be used in
615 632
    websocket:closed event route.
616 633
 
617
-   Example 1.13. $ws_conid usage
634
+   Example 1.14. $ws_conid usage
618 635
 ...
619 636
 event_route[websocket:closed] {
620 637
         xlog("L_INFO", "WebSocket connection with id $ws_conid has closed\n");