TsgcWebSocketServer_HTTPAPI › Methods

TsgcWebSocketServer_HTTPAPI Methoden

Öffentliche Methoden, gruppiert nach Zweck, gefolgt von der vollständigen alphabetischen Liste.

Verbindung

NameBeschreibung
StartStartet den HTTP.sys-Server von einem sekundären Thread aus, sodass der aufrufende Thread nicht blockiert wird, während URL-Gruppen und Bindings registriert werden.
StopStoppt den HTTP.sys-Server von einem sekundären Thread, sodass der aufrufende Thread nicht blockiert wird, während Verbindungen geschlossen und die Request-Queue freigegeben wird.
ReStartStoppt und startet dann den HTTP.sys-Server von einem sekundären Thread aus neu, nützlich nach dem Ändern von Bindings, Ports oder SSL-Zertifikaten zur Laufzeit.
DisconnectAllTrennt jede aktive WebSocket-Verbindung, während der HTTP.sys-Server weiterhin auf neue Verbindungen lauscht.

Messaging

NameBeschreibung
BroadcastSendet dieselbe Nachricht an alle verbundenen Clients, optional gefiltert nach Kanal, Protokoll oder Verbindungs-GUID-Liste.
WriteDataSendet eine Nachricht an einen einzelnen Client, der durch seine Verbindungs-GUID identifiziert wird.
PingSendet einen WebSocket-Ping-Frame an jeden verbundenen Client.

Sharing

NameBeschreibung
ShareListErwirbt eine gemeinsame (schreibgeschützte) Sperre auf der internen Verbindungsliste und gibt sie zur gleichzeitigen Aufzählung zurück.
UnShareListGibt die zuvor von ShareList erworbene gemeinsam genutzte (schreibgeschützte) Sperre frei.

Alle Methoden (alphabetisch)

NameBeschreibung
BroadcastSendet dieselbe Nachricht an alle verbundenen Clients, optional gefiltert nach Kanal, Protokoll oder Verbindungs-GUID-Liste.
DisconnectAllTrennt jede aktive WebSocket-Verbindung, während der HTTP.sys-Server weiterhin auf neue Verbindungen lauscht.
PingSendet einen WebSocket-Ping-Frame an jeden verbundenen Client.
ReStartStoppt und startet dann den HTTP.sys-Server von einem sekundären Thread aus neu, nützlich nach dem Ändern von Bindings, Ports oder SSL-Zertifikaten zur Laufzeit.
ShareListErwirbt eine gemeinsame (schreibgeschützte) Sperre auf der internen Verbindungsliste und gibt sie zur gleichzeitigen Aufzählung zurück.
StartStartet den HTTP.sys-Server von einem sekundären Thread aus, sodass der aufrufende Thread nicht blockiert wird, während URL-Gruppen und Bindings registriert werden.
StopStoppt den HTTP.sys-Server von einem sekundären Thread, sodass der aufrufende Thread nicht blockiert wird, während Verbindungen geschlossen und die Request-Queue freigegeben wird.
UnShareListGibt die zuvor von ShareList erworbene gemeinsam genutzte (schreibgeschützte) Sperre frei.
WriteDataSendet eine Nachricht an einen einzelnen Client, der durch seine Verbindungs-GUID identifiziert wird.