mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-15 12:40:30 +00:00
895bc7721a
This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
28 lines
660 B
Markdown
28 lines
660 B
Markdown
---
|
|
module: [kind=event] websocket_closed
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: LicenseRef-CCPL
|
|
-->
|
|
|
|
The @{websocket_closed} event is fired when an open WebSocket connection is closed.
|
|
|
|
## Return Values
|
|
1. @{string}: The event name.
|
|
2. @{string}: The URL of the WebSocket that was closed.
|
|
|
|
## Example
|
|
Prints a message when a WebSocket is closed (this may take a minute):
|
|
```lua
|
|
local myURL = "wss://example.tweaked.cc/echo"
|
|
local ws = http.websocket(myURL)
|
|
local event, url
|
|
repeat
|
|
event, url = os.pullEvent("websocket_closed")
|
|
until url == myURL
|
|
print("The WebSocket at " .. url .. " was closed.")
|
|
```
|