Skip to content

WebSocketClientState

enum cAlgo.API

DesktopCLICloud

An enumeration of different Web socket client states.

Definition

public enum WebSocketClientState

Namespace: cAlgo.API · Group: WebSocket

Examples

var client = new WebSocketClient();
client.Connect(new Uri("wss://stream.example.com/quotes"));
if (client.State == WebSocketClientState.Open)
    client.Send("subscribe EURUSD");
else
    Print("WebSocket state: {0}", client.State);

from System import Uri

client = WebSocketClient()
client.Connect(Uri("wss://stream.example.com/quotes"))
if client.State == WebSocketClientState.Open:
    client.Send("subscribe EURUSD")
else:
    api.Print(f"WebSocket state: {client.State}")

Values

Name Value Description
None 0 Reserved for future use.
Connecting 1 The connection is negotiating the handshake with the remote endpoint.
Open 2 The initial state after the HTTP handshake has been completed.
CloseSent 3 A close message was sent to the remote endpoint.
CloseReceived 4 A close message was received from the remote endpoint.
Closed 5 Indicates the WebSocket close handshake completed gracefully.
Aborted 6 Indicates that the WebSocket has been aborted.

See also