mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-11-14 13:54:52 +00:00
52b78f92cd
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
34 lines
884 B
Markdown
34 lines
884 B
Markdown
---
|
|
module: [kind=event] websocket_message
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
The [`websocket_message`] event is fired when a message is received on an open WebSocket connection.
|
|
|
|
This event is normally handled by [`http.Websocket.receive`], but it can also be pulled manually.
|
|
|
|
## Return Values
|
|
1. [`string`]: The event name.
|
|
2. [`string`]: The URL of the WebSocket.
|
|
3. [`string`]: The contents of the message.
|
|
4. [`boolean`]: Whether this is a binary message.
|
|
|
|
## Example
|
|
Prints a message sent by a WebSocket:
|
|
```lua
|
|
local myURL = "wss://example.tweaked.cc/echo"
|
|
local ws = http.websocket(myURL)
|
|
ws.send("Hello!")
|
|
local event, url, message
|
|
repeat
|
|
event, url, message = os.pullEvent("websocket_message")
|
|
until url == myURL
|
|
print("Received message from " .. url .. " with contents " .. message)
|
|
ws.close()
|
|
```
|