mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-09-15 16:59:43 +00:00
8a203e7454
- Several files where @MCJack123 is the exclusive contributor. He has signed over all contributions to "any OSI-approved license". Thank you! - Various the file handle classes: Looking at these again, I don't think they contain any of the original code.
34 lines
878 B
Markdown
34 lines
878 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()
|
|
```
|