TsgcWebSocketHTTPServer › プロパティ

TsgcWebSocketHTTPServer プロパティ

公開プロパティを目的別にグループ化し、完全なアルファベット順リストを続けます。

接続

名前説明
Active設定されたバインディングでリスニングソケットを開いて HTTP/WebSocket サーバーを起動または停止します。
Portサーバーが受信HTTPおよびWebSocket接続を受け付けるTCPポートです。
Bindingsサーバーがリスンする IP/ポートペアのコレクション。複数のエンドポイントに同時にバインドするために使用します。
MaxConnectionsサーバーが受け入れる同時クライアント接続の最大数。
KeepAliveレスポンスが送信された後も後続のリクエストが再利用できるよう HTTP 接続を開いたままにします。

HTTP

名前説明
DocumentRoot静的ファイル(HTML、JavaScript、CSS、画像など)用の組み込み HTTP サーバーが提供するディレクトリ。
HTTP2OptionsHTTPSリクエストを処理するために使用されるHTTP/2プロトコルハンドラーを有効にして調整します。
HTTPUploadFilesHTTP POST 経由でアップロードされたファイルのバッファリング方法(メモリまたはファイルストリーム)とディスクへの保存を制御します。

セッション

名前説明
AutoStartSessionセッション状態が有効な場合、受信リクエストごとに新しい HTTP セッションを自動的に作成します。
SessionStateステートレスなHTTPプロトコルの上に、CookieベースのHTTPセッション追跡を有効にします。
SessionTimeOutアイドルタイムアウト(ミリ秒単位)です。これを超えると、HTTPセッションは期限切れとみなされ、削除の対象になります。

セキュリティ

名前説明
Authentication受信する WebSocket および HTTP 接続のユーザー/パスワード認証を有効にして設定します。
SSLサーバーで TLS/SSL を有効にして、クライアントが wss:// または https:// を使用して接続できるようにします。
SSLOptionsTLSリスナーの証明書パス、TLSバージョン選択、およびOpenSSLチューニングを保持します。
SecurityOptionsブラウザの WebSocket ハンドシェイクに許可されたオリジンなどのアドミッションルールを定義します。
APIKeyManager接続を受け入れる前に受信APIキーを検証するために使用される、オプションのAPIキーマネージャーコンポーネント。

信頼性

名前説明
HeartBeatアイドル状態のクライアント接続を維持し、死んだピアを検出するために、定期的にpingフレームを送信します。
WatchDog予期しないシャットダウンまたはリスナーの障害後にサーバーを自動的に再起動します。
LoadBalancerこのサーバーをロードバランサーサーバーインスタンスに登録するために使用する組み込みクライアントを設定します。
FallBackネイティブ WebSocket をサポートしていないブラウザに代替トランスポートを提供します。
RateLimiterクライアントまたは IP ごとのリクエストとメッセージレートを制限するレートリミッターコンポーネントを割り当てます。
FirewallIP、地域、またはカスタムルールによって受信接続をフィルタリングするファイアウォールコンポーネントを割り当てます。

詳細設定

名前説明
Optionsフラグメント処理、タイムアウト、HTTP テストページ、UTF-8 検証などのその他のサーバー動作フラグをバンドルします。
QueueOptionsスレッド間の競合を防ぐために、内部の接続ごとのキューを通じてアウトバウンドメッセージをシリアライズします。
Extensionsメッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を設定します。
Specificationsサーバーが受け入れる WebSocket プロトコル仕様を有効または無効にします。
IOHandlerOptions接続をサービスするために使用される I/O 戦略を選択します: スレッドごとの接続、IOCP、または EPOLL。
ThreadPool接続が閉じられたときにワーカースレッドを破棄する代わりに再利用するスレッドプールを有効にします。
ThreadPoolOptionsThreadPool が有効な場合に使用される再利用可能なスレッドプールのサイズと上限を設定します。
Throttleサーバーが各接続から読み取るまたは書き込む帯域幅 (ビット/秒) を制限します。

診断

名前説明
LogFileデバッグと監査のために、すべての受信・送信ソケットメッセージをログファイルに書き込みます。
NotifyEventsスレッド化されたWebSocketイベントがメインVCLスレッドとどのように同期されるかを制御します。
Versionバイナリに埋め込まれた sgcWebSockets ライブラリバージョンを持つ読み取り専用文字列。

すべてのプロパティ(アルファベット順)

名前説明
Active設定されたバインディングでリスニングソケットを開いて HTTP/WebSocket サーバーを起動または停止します。
APIKeyManager接続を受け入れる前に受信APIキーを検証するために使用される、オプションのAPIキーマネージャーコンポーネント。
Authentication受信する WebSocket および HTTP 接続のユーザー/パスワード認証を有効にして設定します。
AutoStartSessionセッション状態が有効な場合、受信リクエストごとに新しい HTTP セッションを自動的に作成します。
Bindingsサーバーがリスンする IP/ポートペアのコレクション。複数のエンドポイントに同時にバインドするために使用します。
DocumentRoot静的ファイル(HTML、JavaScript、CSS、画像など)用の組み込み HTTP サーバーが提供するディレクトリ。
Extensionsメッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を設定します。
FallBackネイティブ WebSocket をサポートしていないブラウザに代替トランスポートを提供します。
FirewallIP、地域、またはカスタムルールによって受信接続をフィルタリングするファイアウォールコンポーネントを割り当てます。
HeartBeatアイドル状態のクライアント接続を維持し、死んだピアを検出するために、定期的にpingフレームを送信します。
HTTP2OptionsHTTPSリクエストを処理するために使用されるHTTP/2プロトコルハンドラーを有効にして調整します。
HTTPUploadFilesHTTP POST 経由でアップロードされたファイルのバッファリング方法(メモリまたはファイルストリーム)とディスクへの保存を制御します。
IOHandlerOptions接続をサービスするために使用される I/O 戦略を選択します: スレッドごとの接続、IOCP、または EPOLL。
KeepAliveレスポンスが送信された後も後続のリクエストが再利用できるよう HTTP 接続を開いたままにします。
LoadBalancerこのサーバーをロードバランサーサーバーインスタンスに登録するために使用する組み込みクライアントを設定します。
LogFileデバッグと監査のために、すべての受信・送信ソケットメッセージをログファイルに書き込みます。
MaxConnectionsサーバーが受け入れる同時クライアント接続の最大数。
NotifyEventsスレッド化されたWebSocketイベントがメインVCLスレッドとどのように同期されるかを制御します。
Optionsフラグメント処理、タイムアウト、HTTP テストページ、UTF-8 検証などのその他のサーバー動作フラグをバンドルします。
Portサーバーが受信HTTPおよびWebSocket接続を受け付けるTCPポートです。
QueueOptionsスレッド間の競合を防ぐために、内部の接続ごとのキューを通じてアウトバウンドメッセージをシリアライズします。
RateLimiterクライアントまたは IP ごとのリクエストとメッセージレートを制限するレートリミッターコンポーネントを割り当てます。
SecurityOptionsブラウザの WebSocket ハンドシェイクに許可されたオリジンなどのアドミッションルールを定義します。
SessionStateステートレスなHTTPプロトコルの上に、CookieベースのHTTPセッション追跡を有効にします。
SessionTimeOutアイドルタイムアウト(ミリ秒単位)です。これを超えると、HTTPセッションは期限切れとみなされ、削除の対象になります。
Specificationsサーバーが受け入れる WebSocket プロトコル仕様を有効または無効にします。
SSLサーバーで TLS/SSL を有効にして、クライアントが wss:// または https:// を使用して接続できるようにします。
SSLOptionsTLSリスナーの証明書パス、TLSバージョン選択、およびOpenSSLチューニングを保持します。
ThreadPool接続が閉じられたときにワーカースレッドを破棄する代わりに再利用するスレッドプールを有効にします。
ThreadPoolOptionsThreadPool が有効な場合に使用される再利用可能なスレッドプールのサイズと上限を設定します。
Throttleサーバーが各接続から読み取るまたは書き込む帯域幅 (ビット/秒) を制限します。
Versionバイナリに埋め込まれた sgcWebSockets ライブラリバージョンを持つ読み取り専用文字列。
WatchDog予期しないシャットダウンまたはリスナーの障害後にサーバーを自動的に再起動します。