Zdarzenia TsgcWebSocketHTTPServer

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 i jego gotowości do akceptowania połączeń.
OnShutdown	Wywoływane po zatrzymaniu serwera i zakończeniu 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.
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	Wywoływane, gdy pierwsza wiadomość nie pasuje do żadnego ze znanych protokołów, dzięki czemu połączenie może zostać zaakceptowane lub odrzucone.
OnUnknownAuthentication	Wywoływane, gdy uwierzytelnianie jest włączone, a metoda uwierzytelniania nie jest rozpoznawana przez serwer.

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
OnBeforeCommand	Wywoływane przed OnCommandGet lub OnCommandOther, aby żądanie mogło być sprawdzone, autoryzowane lub krótko-obwodowane odpowiedzią 401.
OnCommandGet	Wywoływane, gdy serwer HTTP odbiera żądanie GET, POST lub HEAD, umożliwiając aplikacji przygotowanie odpowiedzi.
OnCommandOther	Wywoływane, gdy serwer HTTP odbiera metodę inną niż GET, POST lub HEAD (PUT, DELETE, OPTIONS, PATCH...).
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.
OnHTTP2BeforeAsyncRequest	Wywoływane przed umieszczeniem żądania HTTP/2 w kolejce, umożliwiając aplikacji wybór, czy zostanie ono wykonane w puli wątków, czy w wątku połączenia.

Sesje

Nazwa	Opis
OnCreateSession	Wywoływane, gdy serwer HTTP musi utworzyć nową sesję, aby aplikacja mogła dostarczyć własną instancję TIdHTTPSession.
OnSessionStart	Wywoływane po uruchomieniu sesji HTTP i dodaniu jej do listy SessionList.
OnSessionEnd	Wywoływane, gdy sesja HTTP zostaje zamknięta, jawnie lub po wygaśnięciu SessionTimeout.
OnInvalidSession	Wywoływane, gdy żądanie HTTP zawiera nieznany lub wygasły identyfikator sesji, umożliwiając aplikacji podjęcie decyzji o sposobie reakcji.

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.
OnLoadBalancerConnect	Wywoływane, gdy serwer łączy się z serwerem równoważenia obciążenia.
OnLoadBalancerDisconnect	Wywoływane gdy serwer rozłącza się z serwerem Load Balancer.
OnLoadBalancerError	Wywoływane w przypadku błędu komunikacji z serwerem Load Balancer.

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.
OnSSLGetHandler	Wywoływane przed utworzeniem procedury obsługi SSL, co umożliwia dostarczenie niestandardowej instancji procedury obsługi po stronie serwera.
OnSSLAfterCreateHandler	Wywoływane po utworzeniu procedury obsługi SSL, umożliwiając dostosowanie jej właściwości.
OnSSLALPNSelect	Wywoływane podczas uzgadniania z włączonym ALPN, aby aplikacja mogła wybrać protokół do negocjacji.
OnSSLVerifyPeer	Wywoływane, gdy VerifyCertificate jest włączone i klient przedstawia certyfikat do zaakceptowania lub odrzucenia.

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.
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.
OnBeforeCommand	Wywoływane przed OnCommandGet lub OnCommandOther, aby żądanie mogło być sprawdzone, autoryzowane lub krótko-obwodowane odpowiedzią 401.
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.
OnCommandGet	Wywoływane, gdy serwer HTTP odbiera żądanie GET, POST lub HEAD, umożliwiając aplikacji przygotowanie odpowiedzi.
OnCommandOther	Wywoływane, gdy serwer HTTP odbiera metodę inną niż GET, POST lub HEAD (PUT, DELETE, OPTIONS, PATCH...).
OnConnect	Wywoływane za każdym razem, gdy z klientem zostanie nawiązane połączenie WebSocket.
OnCreateSession	Wywoływane, gdy serwer HTTP musi utworzyć nową sesję, aby aplikacja mogła dostarczyć własną instancję TIdHTTPSession.
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.
OnHTTP2BeforeAsyncRequest	Wywoływane przed umieszczeniem żądania HTTP/2 w kolejce, umożliwiając aplikacji wybór, czy zostanie ono wykonane w puli wątków, czy w wątku połączenia.
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ść.
OnInvalidSession	Wywoływane, gdy żądanie HTTP zawiera nieznany lub wygasły identyfikator sesji, umożliwiając aplikacji podjęcie decyzji o sposobie reakcji.
OnLoadBalancerConnect	Wywoływane, gdy serwer łączy się z serwerem równoważenia obciążenia.
OnLoadBalancerDisconnect	Wywoływane gdy serwer rozłącza się z serwerem Load Balancer.
OnLoadBalancerError	Wywoływane w przypadku błędu komunikacji z serwerem Load Balancer.
OnMessage	Wywoływane za każdym razem, gdy klient wysyła wiadomość tekstową i zostaje ona odebrana przez serwer.
OnSessionEnd	Wywoływane, gdy sesja HTTP zostaje zamknięta, jawnie lub po wygaśnięciu SessionTimeout.
OnSessionStart	Wywoływane po uruchomieniu sesji HTTP i dodaniu jej do listy SessionList.
OnShutdown	Wywoływane po zatrzymaniu serwera i zakończeniu akceptowania połączeń.
OnSSLAfterCreateHandler	Wywoływane po utworzeniu procedury obsługi SSL, umożliwiając dostosowanie jej właściwości.
OnSSLALPNSelect	Wywoływane podczas uzgadniania z włączonym ALPN, aby aplikacja mogła wybrać protokół do negocjacji.
OnSSLGetHandler	Wywoływane przed utworzeniem procedury obsługi SSL, co umożliwia dostarczenie niestandardowej instancji procedury obsługi po stronie serwera.
OnSSLVerifyPeer	Wywoływane, gdy VerifyCertificate jest włączone i klient przedstawia certyfikat do zaakceptowania lub odrzucenia.
OnStartup	Wywoływane po uruchomieniu serwera i jego 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.
OnUnknownAuthentication	Wywoływane, gdy uwierzytelnianie jest włączone, a metoda uwierzytelniania nie jest rozpoznawana przez serwer.
OnUnknownProtocol	Wywoływane, gdy pierwsza wiadomość nie pasuje do żadnego ze znanych protokołów, dzięki czemu połączenie może zostać zaakceptowane lub odrzucone.