Wez Furlong
42bf5c5e61
We've been hoping that mkdocs-material will ship the much anticipated search enhancements for some time, but it's time to recognize that we need to do something to improve the search results with how things work right now. This is a big commit that changes the titles of the various pages from the code-annotated synopsis to just the name of the function. This makes it much easier now to match things like `kumo.reject` directly, but `reject` remains awkward to find. I think this is the best that we can do at this time. A few functions have been annotated with the `status: deprecated` to show as deprecated in the toc/nav (shows with a little trash can next to the name).
1.9 KiB
kumo.http.connect_websocket
kumo.http.connect_websocket(URL)
{{since('2024.06.10-84e84b89')}}
Constructs a websocket client.
URL is the URL to which the websocket will connect.
It must be either ws:// or wss:// rather than http://
or https://.
If the connection is successful, the return value is a tuple of the resulting websocket stream and the initial HTTP response returned from the URL.
kumo.on('init', function()
kumo.spawn_task {
event_name = 'my.websocket.task',
}
end)
kumo.on('my.websocket.task', function()
local stream, response = kumo.http.connect_websocket 'wss://example.com/'
-- Show the initial response; note that there may not be anything
-- significant contained in the initial response
print(response:status_code(), response:status_reason())
for k, v in pairs(response:headers()) do
print('Header', k, v)
end
print(response:text())
-- Now process data from the connection.
-- This is an infinite loop, so you MUST use `kumo.spawn_task`
-- to this websocket processor, otherwise you will harm the
-- normal operation of the server process.
while true do
local data = stream:recv()
print(kumo.json.parse(data))
end
end)
WebSocketStream Methods
The returned stream object has the following methods:
client:recv()
Waits for and then returns the next packet sent by the server. The returned data is a string.
client:recv_batch(duration)
{{since('2025.03.19-1d3f1f67')}}
Waits for up to duration (which can either be a number of seconds, or a
duration string like 10s) and collects however many messages are sent by the
peer into a batch, which is returned as an array style table.
If the socket disconnects and no messages have been received, an error is raised.
Otherwise, the messages received so far will be returned.
If no messages are returned within the specified duration, the return value will be an empty table.