TsgcWebSocketClient › Methods

TsgcWebSocketClient Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Connection

Name	Description
Start	Connects to the server asynchronously from a secondary thread so the calling thread is not blocked.
Stop	Disconnects from the server asynchronously from a secondary thread so the calling thread is not blocked.
Connect	Opens the WebSocket connection synchronously and blocks the caller until the handshake completes or the timeout elapses.
Disconnect	Closes the WebSocket connection synchronously and blocks the caller until the disconnection completes or the timeout elapses.
Connected	Queries the underlying socket to determine whether the client is currently connected to the server.

Messaging

Name	Description
Ping	Sends a WebSocket ping frame to the server and returns immediately without waiting for the pong response.
WriteData	Sends a text message to the WebSocket server, optionally splitting it into fragments of a given size.
WriteAndWaitData	Sends a text message and blocks the caller until the server responds with a text message or the timeout elapses.

All Methods (alphabetical)

Name	Description
Connect	Opens the WebSocket connection synchronously and blocks the caller until the handshake completes or the timeout elapses.
Connected	Queries the underlying socket to determine whether the client is currently connected to the server.
Disconnect	Closes the WebSocket connection synchronously and blocks the caller until the disconnection completes or the timeout elapses.
Ping	Sends a WebSocket ping frame to the server and returns immediately without waiting for the pong response.
Start	Connects to the server asynchronously from a secondary thread so the calling thread is not blocked.
Stop	Disconnects from the server asynchronously from a secondary thread so the calling thread is not blocked.
WriteAndWaitData	Sends a text message and blocks the caller until the server responds with a text message or the timeout elapses.
WriteData	Sends a text message to the WebSocket server, optionally splitting it into fragments of a given size.