2021-01-19 09:20:52 +00:00
|
|
|
---
|
|
|
|
module: [kind=event] websocket_closed
|
|
|
|
---
|
|
|
|
|
2023-03-15 21:52:13 +00:00
|
|
|
<!--
|
|
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
|
2023-03-28 09:23:28 +00:00
|
|
|
SPDX-License-Identifier: MPL-2.0
|
2023-03-15 21:52:13 +00:00
|
|
|
-->
|
|
|
|
|
2021-01-19 09:20:52 +00:00
|
|
|
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
|
2021-01-23 14:58:08 +00:00
|
|
|
local myURL = "wss://example.tweaked.cc/echo"
|
2021-01-19 09:20:52 +00:00
|
|
|
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.")
|
|
|
|
```
|