1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-15 14:24:55 +00:00
CC-Tweaked/doc/events/websocket_success.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

927 B

module: [kind=event] websocket_success see: http.websocketAsync To open a WebSocket asynchronously.

The @{websocket_success} event is fired when a WebSocket connection request returns successfully.

This event is normally handled inside @{http.websocket}, but it can still be seen when using @{http.websocketAsync}.

Return Values

  1. @{string}: The event name.
  2. @{string}: The URL of the site.
  3. @{http.Websocket}: The handle for the WebSocket.

Example

Prints the content of a website (this may fail if the request fails):

local myURL = "wss://example.tweaked.cc/echo"
http.websocketAsync(myURL)
local event, url, handle
repeat
    event, url, handle = os.pullEvent("websocket_success")
until url == myURL
print("Connected to " .. url)
handle.send("Hello!")
print(handle.receive())
handle.close()