Websocket Tools (dccd.tools.websocket)

Connector objects to WebSockets API client to download data.

class BasisWebSocket(host, conn=None, subs=None, max_retries=5, retry_delay=5)

Basis object to connect at a specified stream to websocket client API.

Parameters:

hoststr

Adress of host to connect.

conndict

Parameters to connection setting.

subsdict

Data to subscribe to a stream.

Attributes:

hoststr

Adress of host to connect.

conn_paradict

Parameters of websocket connection.

wswebsockets.client.WebSocketClientProtocol

Connection with the websocket client.

is_connectbool

• True if connected.

• False`otherwise.

Methods

on_open(**kwargs)

On websocket open.

on_close()

On websocket close print and fire event.

async on_error(error, *args)

On websocket error print and fire event.

async on_message(message)

On websocket display message.

on_open(**kwargs)

On websocket open.

Parameters:

**kwargs

Any relevant keyword arguments to set connection.

async wait_that(is_true)

Wait before running.