WebSocketClientWrapper

QuantConnect.Brokerages.WebSocketClientWrapper

Bases: Object, IWebSocket

Wrapper for System.Net.Websockets.ClientWebSocket to enhance testability

is_open

is_open: bool

Wraps IsAlive

message

message: _EventContainer[
    Callable[[Object, WebSocketMessage], Any], Any
]

Wraps message event

error

error: _EventContainer[
    Callable[[Object, WebSocketError], Any], Any
]

Wraps error event

open

open: _EventContainer[
    Callable[[Object, EventArgs], Any], Any
]

Wraps open method

closed

closed: _EventContainer[
    Callable[[Object, WebSocketCloseData], Any], Any
]

Wraps close method

MessageData

Bases: Object

Defines a message of websocket data

message_type

message_type: Any

Type of message

TextMessage

TextMessage()

Bases: QuantConnect_Brokerages_WebSocketClientWrapper_MessageData

Defines a text-Type message of websocket data

Constructs default instance of the TextMessage

message

message: str

Data contained in message

BinaryMessage

BinaryMessage()

Bases: QuantConnect_Brokerages_WebSocketClientWrapper_MessageData

Defines a byte-Type message of websocket data

Constructs default instance of the BinaryMessage

data

data: List[int]

Data contained in message

count

count: int

Count of message

close

close() -> None

Wraps Close method

connect

connect() -> None

Wraps Connect method

initialize

initialize(url: str, session_token: str = None) -> None

Wraps constructor

Parameters:

Name	Type	Description	Default
`url`	`str`	The target websocket url	required
`session_token`	`str`	The websocket session token	`None`

on_close

on_close(e: WebSocketCloseData) -> None

Event invocator for the close event

This codeEntityType is protected.

on_error

on_error(e: WebSocketError) -> None

Event invocator for the error event

This codeEntityType is protected.

Parameters:

Name	Type	Description	Default
`e`	`WebSocketError`		required

on_message

on_message(e: WebSocketMessage) -> None

Event invocator for the message event

This codeEntityType is protected.

on_open

on_open() -> None

Event invocator for the open event

This codeEntityType is protected.

send

send(data: str) -> None

Wraps send method

Parameters:

Name	Type	Description	Default
`data`	`str`		required