[sr-dev] git:master:d33ee59b: websocket: aligned example statements

Daniel-Constantin Mierla miconda at gmail.com
Fri Nov 16 16:38:22 CET 2018


Module: kamailio
Branch: master
Commit: d33ee59bc807acf95b07838d24b888b14a286ddd
URL: https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b14a286ddd

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-11-16T10:37:19+01:00

websocket: aligned example statements

- few more details about return code of handshake process

---

Modified: src/modules/websocket/doc/websocket_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b14a286ddd.diff
Patch: https://github.com/kamailio/kamailio/commit/d33ee59bc807acf95b07838d24b888b14a286ddd.patch

---

diff --git a/src/modules/websocket/doc/websocket_admin.xml b/src/modules/websocket/doc/websocket_admin.xml
index 055498862e..338d37ef22 100644
--- a/src/modules/websocket/doc/websocket_admin.xml
+++ b/src/modules/websocket/doc/websocket_admin.xml
@@ -90,13 +90,13 @@ event_route[xhttp:request] {
                 # Optional... perform HTTP authentication
 
                 # ws_handle_handshake() exits (no further configuration file
-                # processing of the request) when complete.
+                # processing of the request) when complete in case of failure.
                 if (ws_handle_handshake())
-		{
-			# Optional... cache some information about the
-			# successful connection
-			exit;
-		}
+                {
+                        # Optional... cache some information about the
+                        # successful connection
+                        exit;
+                }
         }
 
         xhttp_reply("404", "Not found", "", "");
@@ -181,9 +181,9 @@ route[WITHINDLG] {
 onreply_route[WS_REPLY] {
         if (nat_uac_test(64)) {
                 # Do NAT traversal stuff for replies to a WebSocket connection
-		# - even if it is not behind a NAT!
+                # - even if it is not behind a NAT!
                 # This won't be needed in the future if Kamailio and the
-		# WebSocket client support Outbound and Path.
+                # WebSocket client support Outbound and Path.
                 add_contact_alias();
         }
 }
@@ -491,7 +491,8 @@ end
 		<para>This function can be used from ANY_ROUTE (but will only
 		work in <emphasis>event_route[xhttp:request]</emphasis>).</para>
 		<note><para>This function returns 0, stopping all further
-		processing of the request, when there is a problem.</para></note>
+		processing of the request, when there is a problem. Otherwise, it
+		returns 1 (or positive number) in case of success.</para></note>
 		<example>
 		<title><function>ws_handle_handshake</function> usage</title>
 		<programlisting format="linespecific">




More information about the sr-dev mailing list