TsgcWebSocketServer › Properties

TsgcWebSocketServer Eigenschaften

Veröffentlichte Eigenschaften, nach Zweck gruppiert, gefolgt von der vollständigen alphabetischen Liste.

Connection

NameBeschreibung
ActiveStartet oder stoppt den Server und öffnet die Listening-Sockets an den konfigurierten Bindings.
PortTCP-Port, auf dem der Server eingehende WebSocket- und HTTP-Verbindungen annimmt.
BindingsSammlung von IP/Port-Paaren, auf denen der Server lauscht; verwenden Sie sie, um mehrere Endpunkte gleichzeitig zu binden.
MaxConnectionsMaximale Anzahl gleichzeitiger Client-Verbindungen, die vom Server akzeptiert werden.

Sicherheit

NameBeschreibung
AuthenticationAktiviert und konfiguriert die Benutzer-/Passwort-Authentifizierung für eingehende WebSocket- und HTTP-Verbindungen.
SSLAktiviert TLS/SSL auf dem Server, sodass Clients über wss:// oder https:// eine Verbindung herstellen können.
SSLOptionsHält Zertifikatspfade, TLS-Versionsauswahl und OpenSSL-Tuning für den TLS-Listener.
SecurityOptionsDefiniert Handshake-Zulassungsregeln: erlaubte Origins und RFC-6455-Versions-/Schlüsselvalidierung.
MaxMessageSizeMaximale Größe einer eingehenden WebSocket-Nachricht in Bytes; schützt den Server vor Speichererschöpfungsangriffen.
APIKeyManagerOptionale API-Schlüssel-Manager-Komponente, die verwendet wird, um eingehende API-Schlüssel zu validieren, bevor eine Verbindung akzeptiert wird.

Zuverlässigkeit

NameBeschreibung
HeartBeatSendet periodische Ping-Frames, um untätige Client-Verbindungen am Leben zu erhalten und tote Peers zu erkennen.
WatchDogStartet den Server nach einem unerwarteten Herunterfahren oder einem Listener-Fehler automatisch neu.
LoadBalancerKonfiguriert den integrierten Client, der zur Registrierung dieses Servers bei einer Load-Balancer-Server-Instanz verwendet wird.
FallBackBietet alternative Transporte für Browser, die native WebSockets nicht unterstützen.
RateLimiterWeist eine Rate-Limiter-Komponente zu, die die Anfrage- und Nachrichtenraten pro Client oder pro IP begrenzt.
FirewallWeist eine Firewall-Komponente zu, die eingehende Verbindungen nach IP, Region oder benutzerdefinierten Regeln filtert.

Erweitert

NameBeschreibung
OptionsBündelt verschiedene Server-Verhaltensflags: Fragmentbehandlung, Timeouts, HTTP-Testseiten und UTF-8-Validierung.
QueueOptionsSerialisiert ausgehende Nachrichten über eine interne Warteschlange pro Verbindung, um Konkurrenz zwischen Threads zu vermeiden.
ExtensionsKonfiguriert WebSocket-Protokollerweiterungen wie Per-Message-Deflate-Komprimierung.
SpecificationsAktiviert oder deaktiviert die WebSocket-Protokollspezifikationen, die der Server akzeptieren wird.
HTTP2OptionsAktiviert und stimmt den HTTP/2-Protokoll-Handler ab, der zur Bedienung von HTTPS-Anfragen verwendet wird.
IOHandlerOptionsWählt die I/O-Strategie aus, die zum Bedienen von Verbindungen verwendet wird: Thread-pro-Verbindung, IOCP oder EPOLL.
ThreadPoolAktiviert einen Thread-Pool, der Worker-Threads wiederverwendet, anstatt sie beim Schließen von Verbindungen zu zerstören.
ThreadPoolOptionsKonfiguriert die Größe und Obergrenze des wiederverwendbaren Thread-Pools.
ThrottleBegrenzt die Bandbreite (Bit pro Sekunde), die der Server von jeder Verbindung liest oder in sie schreibt.

Diagnose

NameBeschreibung
LastErrorSchreibgeschützter String mit der Beschreibung des letzten vom Server gemeldeten Fehlers.
LogFileSchreibt jede eingehende und ausgehende Socket-Nachricht zu Debugging- und Auditing-Zwecken in eine Protokolldatei.
NotifyEventsSteuert, wie threadbasierte WebSocket-Ereignisse mit dem Haupt-VCL-Thread synchronisiert werden.
VersionSchreibgeschützte Zeichenkette mit der in der Binärdatei eingebetteten Version der sgcWebSockets-Bibliothek.

Alle Eigenschaften (alphabetisch)

NameBeschreibung
ActiveStartet oder stoppt den Server und öffnet die Listening-Sockets an den konfigurierten Bindings.
APIKeyManagerOptionale API-Schlüssel-Manager-Komponente, die verwendet wird, um eingehende API-Schlüssel zu validieren, bevor eine Verbindung akzeptiert wird.
AuthenticationAktiviert und konfiguriert die Benutzer-/Passwort-Authentifizierung für eingehende WebSocket- und HTTP-Verbindungen.
BindingsSammlung von IP/Port-Paaren, auf denen der Server lauscht; verwenden Sie sie, um mehrere Endpunkte gleichzeitig zu binden.
ExtensionsKonfiguriert WebSocket-Protokollerweiterungen wie Per-Message-Deflate-Komprimierung.
FallBackBietet alternative Transporte für Browser, die native WebSockets nicht unterstützen.
FirewallWeist eine Firewall-Komponente zu, die eingehende Verbindungen nach IP, Region oder benutzerdefinierten Regeln filtert.
HeartBeatSendet periodische Ping-Frames, um untätige Client-Verbindungen am Leben zu erhalten und tote Peers zu erkennen.
HTTP2OptionsAktiviert und stimmt den HTTP/2-Protokoll-Handler ab, der zur Bedienung von HTTPS-Anfragen verwendet wird.
IOHandlerOptionsWählt die I/O-Strategie aus, die zum Bedienen von Verbindungen verwendet wird: Thread-pro-Verbindung, IOCP oder EPOLL.
LastErrorSchreibgeschützter String mit der Beschreibung des letzten vom Server gemeldeten Fehlers.
LoadBalancerKonfiguriert den integrierten Client, der zur Registrierung dieses Servers bei einer Load-Balancer-Server-Instanz verwendet wird.
LogFileSchreibt jede eingehende und ausgehende Socket-Nachricht zu Debugging- und Auditing-Zwecken in eine Protokolldatei.
MaxConnectionsMaximale Anzahl gleichzeitiger Client-Verbindungen, die vom Server akzeptiert werden.
MaxMessageSizeMaximale Größe einer eingehenden WebSocket-Nachricht in Bytes; schützt den Server vor Speichererschöpfungsangriffen.
NotifyEventsSteuert, wie threadbasierte WebSocket-Ereignisse mit dem Haupt-VCL-Thread synchronisiert werden.
OptionsBündelt verschiedene Server-Verhaltensflags: Fragmentbehandlung, Timeouts, HTTP-Testseiten und UTF-8-Validierung.
PortTCP-Port, auf dem der Server eingehende WebSocket- und HTTP-Verbindungen annimmt.
QueueOptionsSerialisiert ausgehende Nachrichten über eine interne Warteschlange pro Verbindung, um Konkurrenz zwischen Threads zu vermeiden.
RateLimiterWeist eine Rate-Limiter-Komponente zu, die die Anfrage- und Nachrichtenraten pro Client oder pro IP begrenzt.
SecurityOptionsDefiniert Handshake-Zulassungsregeln: erlaubte Origins und RFC-6455-Versions-/Schlüsselvalidierung.
SpecificationsAktiviert oder deaktiviert die WebSocket-Protokollspezifikationen, die der Server akzeptieren wird.
SSLAktiviert TLS/SSL auf dem Server, sodass Clients über wss:// oder https:// eine Verbindung herstellen können.
SSLOptionsHält Zertifikatspfade, TLS-Versionsauswahl und OpenSSL-Tuning für den TLS-Listener.
ThreadPoolAktiviert einen Thread-Pool, der Worker-Threads wiederverwendet, anstatt sie beim Schließen von Verbindungen zu zerstören.
ThreadPoolOptionsKonfiguriert die Größe und Obergrenze des wiederverwendbaren Thread-Pools.
ThrottleBegrenzt die Bandbreite (Bit pro Sekunde), die der Server von jeder Verbindung liest oder in sie schreibt.
VersionSchreibgeschützte Zeichenkette mit der in der Binärdatei eingebetteten Version der sgcWebSockets-Bibliothek.
WatchDogStartet den Server nach einem unerwarteten Herunterfahren oder einem Listener-Fehler automatisch neu.