Module: kamailio Branch: master Commit: e8f25501e63d4aa433d147593922b46a139d6e0f URL: https://github.com/kamailio/kamailio/commit/e8f25501e63d4aa433d147593922b46a...
Author: Kamailio Dev kamailio.dev@kamailio.org Committer: Kamailio Dev kamailio.dev@kamailio.org Date: 2017-01-31T12:31:15+01:00
modules: readme files regenerated - websocket ...
---
Modified: src/modules/websocket/README
---
Diff: https://github.com/kamailio/kamailio/commit/e8f25501e63d4aa433d147593922b46a... Patch: https://github.com/kamailio/kamailio/commit/e8f25501e63d4aa433d147593922b46a...
---
diff --git a/src/modules/websocket/README b/src/modules/websocket/README index 764f1ce..3541db9 100644 --- a/src/modules/websocket/README +++ b/src/modules/websocket/README @@ -32,6 +32,7 @@ Peter Dunkley 4.5. ping_application_data (string) 4.6. sub_protocols (integer) 4.7. cors_mode (integer) + 4.8. verbose_list (int)
5. Functions
@@ -66,10 +67,11 @@ Peter Dunkley 1.7. Set ping_application_data parameter 1.8. Set sub_protocols parameter 1.9. Set cors_mode parameter - 1.10. ws_handle_handshake usage - 1.11. ws_close usage - 1.12. event_route[websocket:closed] usage - 1.13. $ws_conid usage + 1.10. Set verbose_list parameter + 1.11. ws_handle_handshake usage + 1.12. ws_close usage + 1.13. event_route[websocket:closed] usage + 1.14. $ws_conid usage
Chapter 1. Admin Guide
@@ -96,6 +98,7 @@ Chapter 1. Admin Guide 4.5. ping_application_data (string) 4.6. sub_protocols (integer) 4.7. cors_mode (integer) + 4.8. verbose_list (int)
5. Functions
@@ -337,6 +340,7 @@ onreply_route[WS_REPLY] { 4.5. ping_application_data (string) 4.6. sub_protocols (integer) 4.7. cors_mode (integer) + 4.8. verbose_list (int)
4.1. keepalive_mechanism (integer)
@@ -440,6 +444,19 @@ modparam("websocket", "sub_protocols", 2) modparam("websocket", "cors_mode", 2) ...
+4.8. verbose_list (int) + + Allows to enable/disable the printing of debug messages when getting + the list of websocket connections. If enabled, it prints debug messages + every second for ping operations. + + Default value is 0 (disabled). + + Example 1.10. Set verbose_list parameter +... +modparam("websocket", "verbose_list", 1) +... + 5. Functions
5.1. ws_handle_handshake() @@ -459,7 +476,7 @@ Note This function returns 0, stopping all further processing of the request, when there is a problem.
- Example 1.10. ws_handle_handshake usage + Example 1.11. ws_handle_handshake usage ... ws_handle_handshake(); ... @@ -484,7 +501,7 @@ Note
This function can be used from ANY_ROUTE.
- Example 1.11. ws_close usage + Example 1.12. ws_close usage ... ws_close(4000, "Because I say so"); ... @@ -598,7 +615,7 @@ kamcmd ws.enable connection closes. The connection may be identified using the the $si and $sp pseudo-variables.
- Example 1.12. event_route[websocket:closed] usage + Example 1.13. event_route[websocket:closed] usage ... event_route[websocket:closed] { xlog("L_INFO", "WebSocket connection from $si:$sp has closed\n"); @@ -614,7 +631,7 @@ event_route[websocket:closed] { Connection id of closed websocket connection. Can only be used in websocket:closed event route.
- Example 1.13. $ws_conid usage + Example 1.14. $ws_conid usage ... event_route[websocket:closed] { xlog("L_INFO", "WebSocket connection with id $ws_conid has closed\n");
-
Kamailio Dev