Skip to content

WebSocketClient.BinaryReceived

event · WebSocketClient · cAlgo.API

DesktopCLICloud

Occurs when WebSocketClient receives binary data.

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

public event Action<WebSocketClientBinaryReceivedEventArgs> BinaryReceived;

webSocketClient.BinaryReceived += handler  # handler(obj: WebSocketClientBinaryReceivedEventArgs)

Examples

private WebSocketClient _client;

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

private void OnBinaryReceived(WebSocketClientBinaryReceivedEventArgs args)
{
    Print("Received {0} bytes: {1}", args.Data.Length, Encoding.UTF8.GetString(args.Data));
}

from System import Uri
from System.Text import Encoding

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

def on_binary_received(self, args):
    api.Print(f"Received {args.Data.Length} bytes: {Encoding.UTF8.GetString(args.Data)}")