WebSocketClient¶
Summary¶
Represents a web socket client.
Signature
1 |
|
Namespace¶
cAlgo.API
Methods¶
Connect¶
Summary
Connects WebSocketClient to passed URI.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
uri | Uri | The server URI. |
Return Value
void
Close¶
Summary
Gets close status / reason.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
closeStatus | WebSocketClientCloseStatus | |
closeStatusDescription | string |
Return Value
void
Send (2)¶
Send (1 of 2)
Summary
Sends passed text.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
text | string | Text to send. |
Return Value
void
Send (2 of 2)
Summary
Sends passed binary data.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
data | byte[] | Data to send. |
Return Value
void
Dispose¶
Summary
Releases the unmanaged resources used by the WebSocketClient instance.
Signature
1 |
|
Return Value
void
Properties¶
State¶
Summary
Gets current state of WebSocketClient instance.
Signature
1 |
|
Return Value
WebSocketClientState
CloseStatus¶
Summary
Gets close status / reason.
Signature
1 |
|
Return Value
WebSocketClientCloseStatus?
CloseStatusDescription¶
Summary
Gets a description of the reason why the instance was closed.
Signature
1 |
|
Return Value
string
Events¶
Connected¶
Summary
Occurs when WebSocketClient is connected.
Signature
1 |
|
Disconnected¶
Summary
Occurs when WebSocketClient is disconnected.
Signature
1 |
|
TextReceived¶
Summary
Occurs when WebSocketClient receives text data.
Signature
1 |
|
BinaryReceived¶
Summary
Occurs when WebSocketClient receives binary data.
Signature
1 |
|