mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-07-08 12:54:27 +00:00
Code Issues Releases Wiki Activity
cc8c1f38e7
CC-Tweaked/doc/events/websocket_closed.md
Jonathan Coates cc8c1f38e7
Small documentation improvements 
- Document that settings.set doesn't persist values. I think this
   closes #1512 - haven't heard back from them.

 - Add missing close reasons to the websocket_closed event. Closes #1493.

 - Mention what values are preserved by os.queueEvent. This is just the
   same as modem.transmit. Closes #1490.
2023-07-06 23:03:22 +01:00

1.2 KiB
Raw Blame History

module: [kind=event] websocket_closed

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.
  3. @{string}|@{nil}: The server-provided reason the websocket was closed. This will be @{nil} if the connection was closed abnormally.
  4. @{number}|@{nil}: The connection close code, indicating why the socket was closed. This will be @{nil} if the connection was closed abnormally.

Example

Prints a message when a WebSocket is closed (this may take a minute):

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.")