summaryrefslogtreecommitdiff
path: root/modules/websocket/doc_classes
diff options
context:
space:
mode:
authorMeriipu <Meriipu@users.noreply.github.com>2020-06-17 08:14:58 +0200
committerMeriipu <Meriipu@users.noreply.github.com>2021-07-17 07:48:18 +0200
commit1475f617a30a2307db0973502a0599b872d4de0e (patch)
tree22aa9e0fce614da657d37cf817021fc39f016d15 /modules/websocket/doc_classes
parentde83ee57e5bb0e4fb494455a98d597d76289d321 (diff)
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"
Diffstat (limited to 'modules/websocket/doc_classes')
-rw-r--r--modules/websocket/doc_classes/WebSocketServer.xml5
1 files changed, 4 insertions, 1 deletions
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">