mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-16 23:04:53 +00:00
Code Issues Releases Wiki Activity
bc03090ca4
CC-Tweaked/doc/events/websocket_closed.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

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