TsgcWebSocketHTTPServer › Właściwości

TsgcWebSocketHTTPServer Properties

Opublikowane właściwości pogrupowane według przeznaczenia, a następnie pełna lista alfabetyczna.

Połączenie

NazwaOpis
ActiveUruchamia lub zatrzymuje serwer HTTP/WebSocket, otwierając gniazda nasłuchujące na skonfigurowanych powiązaniach.
PortPort TCP, na którym serwer przyjmuje przychodzące połączenia HTTP i WebSocket.
BindingsKolekcja par IP/Port, na których nasłuchuje serwer; umożliwia jednoczesne powiązanie kilku punktów końcowych.
MaxConnectionsMaksymalna liczba jednoczesnych połączeń klienta akceptowanych przez serwer.
KeepAliveUtrzymuje połączenie HTTP otwarte po wysłaniu odpowiedzi, aby kolejne żądania mogły je ponownie wykorzystać.

HTTP

NazwaOpis
DocumentRootKatalog obsługiwany przez wbudowany serwer HTTP dla plików statycznych (HTML, JavaScript, CSS, obrazy itp.).
HTTP2OptionsWłącza i konfiguruje moduł obsługi protokołu HTTP/2 używany do obsługi żądań HTTPS.
HTTPUploadFilesKontroluje sposób buforowania (pamięć lub strumień plikowy) i zapisywania na dysku plików przesłanych przez HTTP POST.

Sesje

NazwaOpis
AutoStartSessionAutomatycznie tworzy nową sesję HTTP dla każdego przychodzącego żądania, gdy włączony jest stan sesji.
SessionStateWłącza śledzenie sesji HTTP opartej na plikach cookie, ponad bezstanowym protokołem HTTP.
SessionTimeOutLimit czasu bezczynności w milisekundach, po upływie którego sesja HTTP jest uznawana za wygasłą i kwalifikuje się do usunięcia.

Bezpieczeństwo

NazwaOpis
AuthenticationWłącza i konfiguruje uwierzytelnianie użytkownik/hasło dla przychodzących połączeń WebSocket i HTTP.
SSLWłącza TLS/SSL na serwerze, aby klienci mogli łączyć się przy użyciu wss:// lub https://.
SSLOptionsPrzechowuje ścieżki certyfikatów, wybór wersji TLS oraz ustawienia OpenSSL dla nasłuchiwacza TLS.
SecurityOptionsDefiniuje reguły dostępu, takie jak dozwolone źródła dla uzgadniania połączeń WebSocket przeglądarki.
APIKeyManagerOpcjonalny komponent zarządzania kluczami API służący do weryfikacji przychodzących kluczy API przed akceptacją połączenia.

Niezawodność

NazwaOpis
HeartBeatWysyła okresowe ramki ping w celu utrzymania bezczynnych połączeń klienta i wykrywania nieaktywnych węzłów.
WatchDogAutomatycznie restartuje serwer po nieoczekiwanym zamknięciu lub awarii nasłuchiwania.
LoadBalancerKonfiguruje wbudowanego klienta używanego do rejestracji tego serwera w instancji serwera Load Balancer.
FallBackZapewnia alternatywne transporty dla przeglądarek, które nie obsługują natywnych WebSockets.
RateLimiterPrzypisuje komponent ogranicznika szybkości, który ogranicza częstotliwość żądań i wiadomości na klienta lub na adres IP.
FirewallPrzypisuje komponent zapory sieciowej filtrujący przychodzące połączenia według adresu IP, regionu lub reguł niestandardowych.

Zaawansowane

NazwaOpis
OptionsGrupuje różne flagi zachowania serwera: obsługę fragmentów, limity czasu, strony testowe HTTP oraz walidację UTF-8.
QueueOptionsSerializuje wychodzące wiadomości przez wewnętrzną kolejkę per-połączenie, zapobiegając rywalizacji między wątkami.
ExtensionsKonfiguruje rozszerzenia protokołu WebSocket, takie jak kompresja per-message deflate.
SpecyfikacjeWłącza lub wyłącza specyfikacje protokołu WebSocket akceptowane przez serwer.
IOHandlerOptionsWybiera strategię wejścia/wyjścia używaną do obsługi połączeń: wątek na połączenie, IOCP lub EPOLL.
ThreadPoolWłącza pulę wątków, która ponownie wykorzystuje wątki robocze zamiast je niszczyć po zamknięciu połączeń.
ThreadPoolOptionsKonfiguruje rozmiar i górną granicę wielokrotnie używanej puli wątków, gdy włączona jest opcja ThreadPool.
ThrottleOgranicza przepustowość (bity na sekundę), jaką serwer odczytuje lub zapisuje dla każdego połączenia.

Diagnostyka

NazwaOpis
LogFileZapisuje każdą przychodzącą i wychodzącą wiadomość gniazda do pliku dziennika na potrzeby debugowania i audytu.
NotifyEventsSteruje sposobem synchronizowania wielowątkowych zdarzeń WebSocket z głównym wątkiem VCL.
VersionCiąg znaków tylko do odczytu z wersją biblioteki sgcWebSockets osadzoną w pliku binarnym.

Wszystkie właściwości (alfabetycznie)

NazwaOpis
ActiveUruchamia lub zatrzymuje serwer HTTP/WebSocket, otwierając gniazda nasłuchujące na skonfigurowanych powiązaniach.
APIKeyManagerOpcjonalny komponent zarządzania kluczami API służący do weryfikacji przychodzących kluczy API przed akceptacją połączenia.
AuthenticationWłącza i konfiguruje uwierzytelnianie użytkownik/hasło dla przychodzących połączeń WebSocket i HTTP.
AutoStartSessionAutomatycznie tworzy nową sesję HTTP dla każdego przychodzącego żądania, gdy włączony jest stan sesji.
BindingsKolekcja par IP/Port, na których nasłuchuje serwer; umożliwia jednoczesne powiązanie kilku punktów końcowych.
DocumentRootKatalog obsługiwany przez wbudowany serwer HTTP dla plików statycznych (HTML, JavaScript, CSS, obrazy itp.).
ExtensionsKonfiguruje rozszerzenia protokołu WebSocket, takie jak kompresja per-message deflate.
FallBackZapewnia alternatywne transporty dla przeglądarek, które nie obsługują natywnych WebSockets.
FirewallPrzypisuje komponent zapory sieciowej filtrujący przychodzące połączenia według adresu IP, regionu lub reguł niestandardowych.
HeartBeatWysyła okresowe ramki ping w celu utrzymania bezczynnych połączeń klienta i wykrywania nieaktywnych węzłów.
HTTP2OptionsWłącza i konfiguruje moduł obsługi protokołu HTTP/2 używany do obsługi żądań HTTPS.
HTTPUploadFilesKontroluje sposób buforowania (pamięć lub strumień plikowy) i zapisywania na dysku plików przesłanych przez HTTP POST.
IOHandlerOptionsWybiera strategię wejścia/wyjścia używaną do obsługi połączeń: wątek na połączenie, IOCP lub EPOLL.
KeepAliveUtrzymuje połączenie HTTP otwarte po wysłaniu odpowiedzi, aby kolejne żądania mogły je ponownie wykorzystać.
LoadBalancerKonfiguruje wbudowanego klienta używanego do rejestracji tego serwera w instancji serwera Load Balancer.
LogFileZapisuje każdą przychodzącą i wychodzącą wiadomość gniazda do pliku dziennika na potrzeby debugowania i audytu.
MaxConnectionsMaksymalna liczba jednoczesnych połączeń klienta akceptowanych przez serwer.
NotifyEventsSteruje sposobem synchronizowania wielowątkowych zdarzeń WebSocket z głównym wątkiem VCL.
OptionsGrupuje różne flagi zachowania serwera: obsługę fragmentów, limity czasu, strony testowe HTTP oraz walidację UTF-8.
PortPort TCP, na którym serwer przyjmuje przychodzące połączenia HTTP i WebSocket.
QueueOptionsSerializuje wychodzące wiadomości przez wewnętrzną kolejkę per-połączenie, zapobiegając rywalizacji między wątkami.
RateLimiterPrzypisuje komponent ogranicznika szybkości, który ogranicza częstotliwość żądań i wiadomości na klienta lub na adres IP.
SecurityOptionsDefiniuje reguły dostępu, takie jak dozwolone źródła dla uzgadniania połączeń WebSocket przeglądarki.
SessionStateWłącza śledzenie sesji HTTP opartej na plikach cookie, ponad bezstanowym protokołem HTTP.
SessionTimeOutLimit czasu bezczynności w milisekundach, po upływie którego sesja HTTP jest uznawana za wygasłą i kwalifikuje się do usunięcia.
SpecyfikacjeWłącza lub wyłącza specyfikacje protokołu WebSocket akceptowane przez serwer.
SSLWłącza TLS/SSL na serwerze, aby klienci mogli łączyć się przy użyciu wss:// lub https://.
SSLOptionsPrzechowuje ścieżki certyfikatów, wybór wersji TLS oraz ustawienia OpenSSL dla nasłuchiwacza TLS.
ThreadPoolWłącza pulę wątków, która ponownie wykorzystuje wątki robocze zamiast je niszczyć po zamknięciu połączeń.
ThreadPoolOptionsKonfiguruje rozmiar i górną granicę wielokrotnie używanej puli wątków, gdy włączona jest opcja ThreadPool.
ThrottleOgranicza przepustowość (bity na sekundę), jaką serwer odczytuje lub zapisuje dla każdego połączenia.
VersionCiąg znaków tylko do odczytu z wersją biblioteki sgcWebSockets osadzoną w pliku binarnym.
WatchDogAutomatycznie restartuje serwer po nieoczekiwanym zamknięciu lub awarii nasłuchiwania.