TsgcWebSocketServer_HTTPAPI › Ereignisse

TsgcWebSocketServer_HTTPAPI Events

Ereignisse, die Sie behandeln können, nach Zweck gruppiert, gefolgt von der vollständigen alphabetischen Liste.

Lebenszyklus

NameBeschreibung
OnStartupWird ausgelöst, nachdem der HTTP-API-Server gestartet wurde und bereit ist, Verbindungen anzunehmen.
OnShutdownWird ausgelöst, nachdem der HTTP-API-Server gestoppt wurde und keine weiteren Anfragen akzeptiert werden.
OnBeforeBindingWird ausgelöst, bevor der Server an die konfigurierte URL bindet, sodass die Liste der Bindings inspiziert oder angepasst werden kann.
OnTCPConnectWird ausgelöst, nachdem sich ein Client auf TCP-Ebene verbunden hat und vor dem WebSocket-Handshake, sodass die Verbindung akzeptiert oder abgelehnt werden kann.
OnConnectWird jedes Mal ausgelöst, wenn eine WebSocket-Verbindung mit einem Client hergestellt wird.
OnDisconnectWird jedes Mal ausgelöst, wenn eine WebSocket-Verbindung mit einem Client getrennt wird.
OnHandshakeWird ausgelöst, nachdem der Handshake auf der Serverseite ausgewertet wurde und bevor die Antwort gesendet wird.
OnErrorWird immer dann ausgelöst, wenn ein WebSocket-Protokollfehler auftritt, etwa ein fehlerhafter Handshake.
OnExceptionWird ausgelöst, wenn beim Verarbeiten einer Client-Verbindung eine nicht behandelte Ausnahme auftritt.
OnUnknownProtocolDerzeit nicht vom HTTP-API-Server unterstützt; aus Gründen der API-Kompatibilität mit TsgcWebSocketServer deklariert.

Data

NameBeschreibung
OnMessageWird jedes Mal ausgelöst, wenn ein Client eine Textnachricht sendet und sie vom Server empfangen wird.
OnBinaryWird jedes Mal ausgelöst, wenn ein Client eine Binärnachricht sendet und sie vom Server empfangen wird.
OnFragmentedWird ausgelöst, wenn ein Fragment einer Nachricht empfangen wird (nur wenn Options.FragmentedMessages frgAll oder frgOnlyFragmented ist).

HTTP

NameBeschreibung
OnHTTPRequestWird ausgelöst, wenn der Server eine HTTP-Anfrage empfängt, sodass die Anwendung die Antwort erstellen kann.
OnBeforeForwardHTTPWird ausgelöst, bevor eine HTTP-Anfrage versendet wird, damit sie an einen anderen HTTP-Server weitergeleitet (reverse-proxied) werden kann.
OnAfterForwardHTTPWird ausgelöst, nachdem eine HTTP-Anfrage weitergeleitet wurde, sodass die Anwendung das Ergebnis oder einen vom Upstream-Server zurückgegebenen Fehler prüfen kann.

HTTP Upload

NameBeschreibung
OnHTTPUploadBeforeSaveFileWird ausgelöst, bevor eine aus einem multipart/form-data-Upload extrahierte Datei auf die Festplatte gespeichert wird, sodass Name und Pfad angepasst werden können.
OnHTTPUploadAfterSaveFileWird ausgelöst, nachdem eine aus einem multipart/form-data-Upload extrahierte Datei auf der Festplatte gespeichert wurde.
OnHTTPUploadReadInputWird ausgelöst, wenn der multipart/form-data-Decoder ein Nicht-Datei-Eingabefeld liest, sodass dessen Wert erfasst werden kann.
OnHTTPUploadBeforeCreatePostStreamWird ausgelöst, nachdem die Anfrage-Header gelesen wurden und bevor der POST-Stream erstellt wird, sodass der Upload angenommen oder abgelehnt werden kann.

Zuverlässigkeit

NameBeschreibung
OnBeforeHeartBeatWird vor jedem HeartBeat-Ping ausgelöst, sodass die Anwendung ein benutzerdefiniertes Keep-Alive implementieren kann.
OnAsynchronousWird ausgelöst, wenn eine vom HTTP-API-Server initiierte asynchrone Sendeoperation abgeschlossen ist.

Sicherheit

NameBeschreibung
OnAuthenticationWird ausgelöst, wenn die Authentifizierung aktiviert ist, sodass die Anwendung Benutzer und Passwort prüfen und die Verbindung annehmen oder ablehnen kann.

Alle Ereignisse (alphabetisch)

NameBeschreibung
OnAfterForwardHTTPWird ausgelöst, nachdem eine HTTP-Anfrage weitergeleitet wurde, sodass die Anwendung das Ergebnis oder einen vom Upstream-Server zurückgegebenen Fehler prüfen kann.
OnAsynchronousWird ausgelöst, wenn eine vom HTTP-API-Server initiierte asynchrone Sendeoperation abgeschlossen ist.
OnAuthenticationWird ausgelöst, wenn die Authentifizierung aktiviert ist, sodass die Anwendung Benutzer und Passwort prüfen und die Verbindung annehmen oder ablehnen kann.
OnBeforeBindingWird ausgelöst, bevor der Server an die konfigurierte URL bindet, sodass die Liste der Bindings inspiziert oder angepasst werden kann.
OnBeforeForwardHTTPWird ausgelöst, bevor eine HTTP-Anfrage versendet wird, damit sie an einen anderen HTTP-Server weitergeleitet (reverse-proxied) werden kann.
OnBeforeHeartBeatWird vor jedem HeartBeat-Ping ausgelöst, sodass die Anwendung ein benutzerdefiniertes Keep-Alive implementieren kann.
OnBinaryWird jedes Mal ausgelöst, wenn ein Client eine Binärnachricht sendet und sie vom Server empfangen wird.
OnConnectWird jedes Mal ausgelöst, wenn eine WebSocket-Verbindung mit einem Client hergestellt wird.
OnDisconnectWird jedes Mal ausgelöst, wenn eine WebSocket-Verbindung mit einem Client getrennt wird.
OnErrorWird immer dann ausgelöst, wenn ein WebSocket-Protokollfehler auftritt, etwa ein fehlerhafter Handshake.
OnExceptionWird ausgelöst, wenn beim Verarbeiten einer Client-Verbindung eine nicht behandelte Ausnahme auftritt.
OnFragmentedWird ausgelöst, wenn ein Fragment einer Nachricht empfangen wird (nur wenn Options.FragmentedMessages frgAll oder frgOnlyFragmented ist).
OnHandshakeWird ausgelöst, nachdem der Handshake auf der Serverseite ausgewertet wurde und bevor die Antwort gesendet wird.
OnHTTPRequestWird ausgelöst, wenn der Server eine HTTP-Anfrage empfängt, sodass die Anwendung die Antwort erstellen kann.
OnHTTPUploadAfterSaveFileWird ausgelöst, nachdem eine aus einem multipart/form-data-Upload extrahierte Datei auf der Festplatte gespeichert wurde.
OnHTTPUploadBeforeCreatePostStreamWird ausgelöst, nachdem die Anfrage-Header gelesen wurden und bevor der POST-Stream erstellt wird, sodass der Upload angenommen oder abgelehnt werden kann.
OnHTTPUploadBeforeSaveFileWird ausgelöst, bevor eine aus einem multipart/form-data-Upload extrahierte Datei auf die Festplatte gespeichert wird, sodass Name und Pfad angepasst werden können.
OnHTTPUploadReadInputWird ausgelöst, wenn der multipart/form-data-Decoder ein Nicht-Datei-Eingabefeld liest, sodass dessen Wert erfasst werden kann.
OnMessageWird jedes Mal ausgelöst, wenn ein Client eine Textnachricht sendet und sie vom Server empfangen wird.
OnShutdownWird ausgelöst, nachdem der HTTP-API-Server gestoppt wurde und keine weiteren Anfragen akzeptiert werden.
OnStartupWird ausgelöst, nachdem der HTTP-API-Server gestartet wurde und bereit ist, Verbindungen anzunehmen.
OnTCPConnectWird ausgelöst, nachdem sich ein Client auf TCP-Ebene verbunden hat und vor dem WebSocket-Handshake, sodass die Verbindung akzeptiert oder abgelehnt werden kann.
OnUnknownProtocolDerzeit nicht vom HTTP-API-Server unterstützt; aus Gründen der API-Kompatibilität mit TsgcWebSocketServer deklariert.