ezmsg.websocket.units#

Classes

WebsocketClient(*args[, settings])

WebsocketServer(*args[, settings])

Receives arbitrary content from outside world and injects it into system in a DataArray

WebsocketSettings(host, port[, cert_path])

WebsocketState()

class WebsocketSettings(host, port, cert_path=None)[source]#

Bases: Settings

Parameters:

  • host (str)

  • port (int)

  • cert_path (str | None)

host: str#
port: int#
cert_path: Optional[str] = None#
__init__(host, port, cert_path=None)#
Parameters:

  • host (str)

  • port (int)

  • cert_path (str | None)

Return type:

None

class WebsocketState[source]#

Bases: State

incoming_queue: Queue[Union[str, bytes]]#
outgoing_queue: Queue[Union[str, bytes]]#
class WebsocketServer(*args, settings=None, **kwargs)[source]#

Bases: Unit

Receives arbitrary content from outside world and injects it into system in a DataArray

Parameters:

settings (Settings | None)

SETTINGS#

alias of WebsocketSettings

STATE#

alias of WebsocketState

INPUT = InputStream:unlocated[<class 'bytes'>]()#
OUTPUT = OutputStream:unlocated[<class 'bytes'>](self.num_buffers=32, self.force_tcp=False)#
async start_server()[source]#
async publish_incoming()[source]#
async transmit_outgoing(message)[source]#
Parameters:

message (bytes)

class WebsocketClient(*args, settings=None, **kwargs)[source]#

Bases: Unit

Parameters:

settings (Settings | None)

SETTINGS#

alias of WebsocketSettings

STATE#

alias of WebsocketState

INPUT = InputStream:unlocated[<class 'bytes'>]()#
OUTPUT = OutputStream:unlocated[<class 'bytes'>](self.num_buffers=32, self.force_tcp=False)#
async rx_from(websocket)[source]#
Parameters:

websocket (WebSocketClientProtocol)

async tx_to(websocket)[source]#
Parameters:

websocket (WebSocketClientProtocol)

async connection()[source]#
async receive()[source]#
Return type:

AsyncGenerator

async transmit(message)[source]#
Return type:

None

Parameters:

message (bytes)