From 1475f617a30a2307db0973502a0599b872d4de0e Mon Sep 17 00:00:00 2001
From: Meriipu <Meriipu@users.noreply.github.com>
Date: Wed, 17 Jun 2020 08:14:58 +0200
Subject: Expose the resource name the client used to the websocket server

This information is exposed to the websocket server through the
client_connected-signal.

example.com/chat?id=10 gives the resource name "/chat?id=10"
---
 modules/websocket/doc_classes/WebSocketServer.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'modules/websocket/doc_classes')

diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml
index 26e09fd8b3..5491f7de15 100644
--- a/modules/websocket/doc_classes/WebSocketServer.xml
+++ b/modules/websocket/doc_classes/WebSocketServer.xml
@@ -116,8 +116,11 @@
 			</argument>
 			<argument index="1" name="protocol" type="String">
 			</argument>
+			<argument index="2" name="resource_name" type="String">
+			</argument>
 			<description>
-				Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client.
+				Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client, and "resource_name" will be the resource name of the URI the peer used.
+				"resource_name" is a path (at the very least a single forward slash) and potentially a query string.
 			</description>
 		</signal>
 		<signal name="client_disconnected">
-- 
cgit v1.2.3