1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 04:00:30 +00:00
CC-Tweaked/doc/events/websocket_success.md
Jonathan Coates 895bc7721a
License CC:T according to the REUSE specification (#1351)
This adds SPDX license headers to all source code files, following the
REUSE[1] specification. This does not include any asset files (such as
generated JSON files, or textures). While REUSE does support doing so
with ".license" files, for now we define these licences using the
.reuse/dep5 file.

[1]: https://reuse.software/
2023-03-15 21:52:13 +00:00

935 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()