TsgcWebSocketServer_HTTPAPI › Methods

TsgcWebSocketServer_HTTPAPI Methods

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

Connection

NameDescription
StartStarts the HTTP.sys server from a secondary thread so the calling thread is not blocked while URL groups and bindings are registered.
StopStops the HTTP.sys server from a secondary thread so the calling thread is not blocked while connections are closed and the request queue is released.
ReStartStops and then restarts the HTTP.sys server from a secondary thread, useful after changing bindings, ports or SSL certificates at runtime.
DisconnectAllDisconnects every active WebSocket connection while keeping the HTTP.sys server listening for new connections.

Messaging

NameDescription
BroadcastSends the same message to all connected clients, optionally filtered by channel, protocol, or connection GUID list.
WriteDataSends a message to a single client identified by its connection GUID.
PingSends a WebSocket ping frame to every connected client.

Sharing

NameDescription
ShareListAcquires a shared (read-only) lock on the internal connection list and returns it for concurrent enumeration.
UnShareListReleases the shared (read-only) lock previously acquired by ShareList.

All Methods (alphabetical)

NameDescription
BroadcastSends the same message to all connected clients, optionally filtered by channel, protocol, or connection GUID list.
DisconnectAllDisconnects every active WebSocket connection while keeping the HTTP.sys server listening for new connections.
PingSends a WebSocket ping frame to every connected client.
ReStartStops and then restarts the HTTP.sys server from a secondary thread, useful after changing bindings, ports or SSL certificates at runtime.
ShareListAcquires a shared (read-only) lock on the internal connection list and returns it for concurrent enumeration.
StartStarts the HTTP.sys server from a secondary thread so the calling thread is not blocked while URL groups and bindings are registered.
StopStops the HTTP.sys server from a secondary thread so the calling thread is not blocked while connections are closed and the request queue is released.
UnShareListReleases the shared (read-only) lock previously acquired by ShareList.
WriteDataSends a message to a single client identified by its connection GUID.