noccy/react-websocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation for connection groups

Browse Source
This commit is contained in:
Chris 2024-02-21 12:57:10 +01:00
parent c855fc177f
commit 065d96f90a
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ConnectionGroups.md
View File

@ -13,4 +13,6 @@ foreach ($websocket->getGroup() as $other) {
} }
``` ```
To remove a group from a connection, call `setGroup(null)`. To remove a group from a connection, pass `null` to `WebSocketConnection::setGroup()`.
The group will emit a `join` event (`WebSocketConnection::EVENT_JOIN`) when another member joins the group, and a `leave` event (`WebSocketConnection::EVENT_LEAVE`) when a member leaves. The events will be sent to the leaving member as well, so consider this in your logic.