WebSocketClient.Dispose

method · WebSocketClient · cAlgo.API

DesktopCLICloud

Releases the unmanaged resources used by the WebSocketClient instance.

Environment behaviour

Cloud — not supported. Connect, Send and Close do nothing: "WebSocket is not supported in cloud environment." is written to the log, State stays None and no events are raised.

Definition

C#Python

public void Dispose()

webSocketClient.Dispose() -> None

Examples

C#Python

private WebSocketClient _client;

protected override void OnStart()
{
    _client = new WebSocketClient();
    _client.Connect(new Uri("wss://stream.example.com/quotes"));
}

protected override void OnStop()
{
    _client.Dispose();
    Print("WebSocket disposed, state: {0}", _client.State);
}

from System import Uri

def on_start(self):
    self.client = WebSocketClient()
    self.client.Connect(Uri("wss://stream.example.com/quotes"))

def on_stop(self):
    self.client.Dispose()
    api.Print(f"WebSocket disposed, state: {self.client.State}")