IWebSocket

QuantConnect.Brokerages.IWebSocket

Wrapper for WebSocket4Net to enhance testability

is_open

is_open: bool

Wraps IsOpen

message

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

on message event

error

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

On error event

open

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

On Open event

closed

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

On Close event

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

send

send(data: str) -> None

Wraps send method

Parameters:

Name	Type	Description	Default
data	str		required