1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-05 09:36:19 +00:00
CC-Tweaked/doc/events/websocket_closed.md
Jonathan Coates 8a203e7454
Re-license several more files under MPL-2.0
- 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.
2023-03-28 10:28:59 +01:00

652 B

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.

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