Zdarzenia TsgcWebSocketServer_HTTPAPI

Zdarzenia, które można obsługiwać, pogrupowane według przeznaczenia, a następnie pełna lista alfabetyczna.

Cykl życia

Nazwa	Opis
OnStartup	Wywoływane po uruchomieniu serwera HTTP API i gotowości do akceptowania połączeń.
OnShutdown	Wywoływane po zatrzymaniu serwera HTTP API, gdy żadne dalsze żądania nie są przyjmowane.
OnBeforeBinding	Wywoływane przed powiązaniem serwera ze skonfigurowanym URL, umożliwiając inspekcję lub dostosowanie listy powiązań.
OnTCPConnect	Wywoływane po połączeniu klienta na poziomie TCP i przed uzgadnianiem WebSocket, umożliwiając zaakceptowanie lub odrzucenie połączenia.
OnConnect	Wywoływane za każdym razem, gdy z klientem zostanie nawiązane połączenie WebSocket.
OnDisconnect	Wywoływane za każdym razem, gdy połączenie WebSocket z klientem zostaje przerwane.
OnHandshake	Wywoływane po ocenie uzgadniania po stronie serwera i przed wysłaniem odpowiedzi.
OnError	Wywoływane za każdym razem, gdy wystąpi błąd protokołu WebSocket, np. nieprawidłowo sformowany handshake.
OnException	Wywoływane za każdym razem, gdy podczas przetwarzania połączenia klienta zostanie zgłoszony nieobsługiwany wyjątek.
OnUnknownProtocol	Aktualnie nieobsługiwane przez serwer HTTP API; zadeklarowane w celu zachowania zgodności API z TsgcWebSocketServer.

Dane

Nazwa	Opis
OnMessage	Wywoływane za każdym razem, gdy klient wysyła wiadomość tekstową i zostaje ona odebrana przez serwer.
OnBinary	Wywoływane za każdym razem, gdy klient wyśle wiadomość binarną, a serwer ją odbierze.
OnFragmented	Wywoływane po odebraniu fragmentu wiadomości (tylko gdy Options.FragmentedMessages ma wartość frgAll lub frgOnlyFragmented).

HTTP

Nazwa	Opis
OnHTTPRequest	Wywoływane, gdy serwer odbiera żądanie HTTP, dzięki czemu aplikacja może zbudować odpowiedź.
OnBeforeForwardHTTP	Wywoływane przed wysłaniem żądania HTTP, aby mogło być ono przekazane (reverse-proxy) do innego serwera HTTP.
OnAfterForwardHTTP	Wywoływane po przesłaniu żądania HTTP, aby aplikacja mogła sprawdzić wynik lub błąd zwrócony przez serwer nadrzędny.

Przesyłanie HTTP

Nazwa	Opis
OnHTTPUploadBeforeSaveFile	Wywoływane przed zapisaniem na dysku pliku wyodrębnionego z przesłanego formularza multipart/form-data, co umożliwia dostosowanie nazwy i ścieżki.
OnHTTPUploadAfterSaveFile	Wywoływane po zapisaniu na dysku pliku wyodrębnionego z przesyłanego multipart/form-data.
OnHTTPUploadReadInput	Wywoływane, gdy dekoder multipart/form-data odczytuje pole wejściowe niebędące plikiem, aby można było przechwycić jego wartość.
OnHTTPUploadBeforeCreatePostStream	Wywoływane po odczytaniu nagłówków żądania, a przed utworzeniem strumienia POST, umożliwiając akceptację lub odrzucenie przesyłania.

Niezawodność

Nazwa	Opis
OnBeforeHeartBeat	Wywoływane przed każdym pingiem HeartBeat, umożliwiając aplikacji implementację niestandardowego mechanizmu utrzymywania połączenia.
OnAsynchronous	Wywoływane po zakończeniu asynchronicznej operacji wysyłania zainicjowanej przez serwer HTTP API.

Bezpieczeństwo

Nazwa	Opis
OnAuthentication	Wywoływane, gdy uwierzytelnianie jest włączone, co umożliwia aplikacji sprawdzenie nazwy użytkownika i hasła oraz zaakceptowanie lub odrzucenie połączenia.

Wszystkie zdarzenia (alfabetycznie)

Nazwa	Opis
OnAfterForwardHTTP	Wywoływane po przesłaniu żądania HTTP, aby aplikacja mogła sprawdzić wynik lub błąd zwrócony przez serwer nadrzędny.
OnAsynchronous	Wywoływane po zakończeniu asynchronicznej operacji wysyłania zainicjowanej przez serwer HTTP API.
OnAuthentication	Wywoływane, gdy uwierzytelnianie jest włączone, co umożliwia aplikacji sprawdzenie nazwy użytkownika i hasła oraz zaakceptowanie lub odrzucenie połączenia.
OnBeforeBinding	Wywoływane przed powiązaniem serwera ze skonfigurowanym URL, umożliwiając inspekcję lub dostosowanie listy powiązań.
OnBeforeForwardHTTP	Wywoływane przed wysłaniem żądania HTTP, aby mogło być ono przekazane (reverse-proxy) do innego serwera HTTP.
OnBeforeHeartBeat	Wywoływane przed każdym pingiem HeartBeat, umożliwiając aplikacji implementację niestandardowego mechanizmu utrzymywania połączenia.
OnBinary	Wywoływane za każdym razem, gdy klient wyśle wiadomość binarną, a serwer ją odbierze.
OnConnect	Wywoływane za każdym razem, gdy z klientem zostanie nawiązane połączenie WebSocket.
OnDisconnect	Wywoływane za każdym razem, gdy połączenie WebSocket z klientem zostaje przerwane.
OnError	Wywoływane za każdym razem, gdy wystąpi błąd protokołu WebSocket, np. nieprawidłowo sformowany handshake.
OnException	Wywoływane za każdym razem, gdy podczas przetwarzania połączenia klienta zostanie zgłoszony nieobsługiwany wyjątek.
OnFragmented	Wywoływane po odebraniu fragmentu wiadomości (tylko gdy Options.FragmentedMessages ma wartość frgAll lub frgOnlyFragmented).
OnHandshake	Wywoływane po ocenie uzgadniania po stronie serwera i przed wysłaniem odpowiedzi.
OnHTTPRequest	Wywoływane, gdy serwer odbiera żądanie HTTP, dzięki czemu aplikacja może zbudować odpowiedź.
OnHTTPUploadAfterSaveFile	Wywoływane po zapisaniu na dysku pliku wyodrębnionego z przesyłanego multipart/form-data.
OnHTTPUploadBeforeCreatePostStream	Wywoływane po odczytaniu nagłówków żądania, a przed utworzeniem strumienia POST, umożliwiając akceptację lub odrzucenie przesyłania.
OnHTTPUploadBeforeSaveFile	Wywoływane przed zapisaniem na dysku pliku wyodrębnionego z przesłanego formularza multipart/form-data, co umożliwia dostosowanie nazwy i ścieżki.
OnHTTPUploadReadInput	Wywoływane, gdy dekoder multipart/form-data odczytuje pole wejściowe niebędące plikiem, aby można było przechwycić jego wartość.
OnMessage	Wywoływane za każdym razem, gdy klient wysyła wiadomość tekstową i zostaje ona odebrana przez serwer.
OnShutdown	Wywoływane po zatrzymaniu serwera HTTP API, gdy żadne dalsze żądania nie są przyjmowane.
OnStartup	Wywoływane po uruchomieniu serwera HTTP API i gotowości do akceptowania połączeń.
OnTCPConnect	Wywoływane po połączeniu klienta na poziomie TCP i przed uzgadnianiem WebSocket, umożliwiając zaakceptowanie lub odrzucenie połączenia.
OnUnknownProtocol	Aktualnie nieobsługiwane przez serwer HTTP API; zadeklarowane w celu zachowania zgodności API z TsgcWebSocketServer.