Websocket Client

Provides a Websocket client compatible with Websocket versions [8, 13]

Currently does not support Websocket Extensions

Minimum required usage:

using SimpleWebsockets

client = WebsocketClient()

listen(client, :connect) do ws::WebsocketConnection #must be called before `open`
    #...
end

open(client, "ws://url.url")

Constructor

SimpleWebsockets.WebsocketClient — Type

WebsocketClient([; options...])

Constructs a new WebsocketClient, overriding clientConfig with the passed options.

Example

using SimpleWebsockets
client = WebsocketClient([; options...])

source

Client Methods

Base.open — Method

open(client::WebsocketClient, url::String [, headers::Dict{String, String}; options...])

Open a new websocket client connection at the given url. Blocks until the connection is closed.

Optionally provide custom headers for the http request.

; options... are passed to the underlying HTTP.request

source

Base.isopen — Method

isopen(client::WebsocketClient)::Bool

Returns a Bool indication if the client TCP connection is open.

source

Client Events

Client event callback functions are registered using the listen method.

SimpleWebsockets.listen — Method

listen(callback::Function, client::SimpleWebsockets.WebsocketClient, event::Symbol)

Valid events are:

:connect
:connectError

Example

listen(client, :connect) do ws
    #...
end

source

:connect

Triggered when the client has successfully connected to the server

Returns a WebsocketConnection to the callback.

listen(client, :connect) do ws::SimpleWebsockets.WebsocketConnection
    #...
end

:connectError

Triggered when an attempt to open a client connection fails

listen(client, :connectError) do err::WebsocketError.ConnectError
    # err.msg::String
    # err.log::Function > logs the error message with stack trace
end