TsgcWebSocketServer_HTTPAPI プロパティ

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

接続

名前	説明
Active	HTTP.sys リスナーを起動または停止し、設定された URL を Windows カーネルドライバーに登録します。
Host	http.sys ドライバーに登録する URL を構築するために使用するホスト名または IP アドレス。
Port	`Host` と組み合わせてhttp.sysドライバーがサーバー用に予約するURLを形成するTCPポート。
BindingOptions	起動時に http.sys ドライバーへの URL 予約と SSL 証明書の登録方法を細かく調整します。
MaxConnections	http.sys リスナーが受け付ける同時クライアント接続の最大数 (ゼロは無制限を意味します)。

Windowsのデフォルトを使用するには、このプロパティを空のままにします。

名前	説明
Timeouts	デフォルトの http.sys リクエスト、エンティティボディ、キープアライブ、および送信レートのタイムアウトを上書きします。

セキュリティ

名前	説明
Authentication	受信するWebSocketおよびHTTP要求に対して、ユーザー/パスワード認証を有効にして設定します。
SSL	クライアントが `wss://` または `https://` を使用して接続できるよう http.sys リスナーで TLS/SSL を有効にします。
SSLOptions	SSL が有効な場合に http.sys がリスナーにバインドする Windows 証明書ストアのエントリを識別します。
SecurityOptions	ブラウザの WebSocket ハンドシェイクに許可されたオリジンなどのアドミッションルールを定義します。
APIKeyManager	接続を受け入れる前に受信APIキーを検証するために使用される、オプションのAPIキーマネージャーコンポーネント。

信頼性

名前	説明
HeartBeat	アイドル状態の WebSocket 接続を維持し、デッドピアを検出するために定期的な ping フレームを送信します。
WatchDog	予期しないシャットダウンまたはリスナーの障害後にサーバーを自動的に再起動します。
Firewall	IP、地域、またはカスタムルールによって受信接続をフィルタリングするファイアウォールコンポーネントを割り当てます。
RateLimiter	クライアントまたは IP ごとのリクエストとメッセージレートを制限するレートリミッターコンポーネントを割り当てます。

パフォーマンス

名前	説明
Asynchronous	ファイアアンドフォーゲット送信を有効にします: 呼び出し元は直ちに返り、完了は `OnAsynchronous` イベントを通じて通知されます。
MaxBandwidth	すべての接続にわたる 1 秒あたりの最大許容帯域幅 (バイト単位、ゼロは無制限)。
ThreadPoolSize	IOCPを通じてhttp.sysリクエストキューにサービスを提供するワーカースレッドの数。
ReadBufferSize	http.sys リクエストキューに対する保留中のオーバーラップ読み取りごとに割り当てられる受信バッファのサイズ (バイト単位)。
FineTune	http.sys がリクエストをキューイング、ディスパッチ、完了する方法を制御する低レベルのカーネルモードノブ。

HTTP

名前	説明
HTTPUploadFiles	HTTP POST 経由でアップロードされたファイルのバッファリング方法（メモリまたはファイルストリーム）とディスクへの保存を制御します。

詳細設定

名前	説明
Options	フラグメント処理、書き込みタイムアウト、HTTPテストページ、UTF-8検証などのサーバーの様々な動作フラグをまとめます。
QueueOptions	スレッド間の競合を防ぐために、内部の接続ごとのキューを通じてアウトバウンドメッセージをシリアライズします。
Extensions	メッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を設定します。
Specifications	サーバーが受け入れる WebSocket プロトコル仕様を有効または無効にします。

診断

名前	説明
LogFile	デバッグと監査のために、すべての受信・送信ソケットメッセージをログファイルに書き込みます。
Version	バイナリに埋め込まれた sgcWebSockets ライブラリバージョンを持つ読み取り専用文字列。

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

名前	説明
Active	HTTP.sys リスナーを起動または停止し、設定された URL を Windows カーネルドライバーに登録します。
APIKeyManager	接続を受け入れる前に受信APIキーを検証するために使用される、オプションのAPIキーマネージャーコンポーネント。
Asynchronous	ファイアアンドフォーゲット送信を有効にします: 呼び出し元は直ちに返り、完了は `OnAsynchronous` イベントを通じて通知されます。
Authentication	受信するWebSocketおよびHTTP要求に対して、ユーザー/パスワード認証を有効にして設定します。
BindingOptions	起動時に http.sys ドライバーへの URL 予約と SSL 証明書の登録方法を細かく調整します。
Extensions	メッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を設定します。
FineTune	http.sys がリクエストをキューイング、ディスパッチ、完了する方法を制御する低レベルのカーネルモードノブ。
Firewall	IP、地域、またはカスタムルールによって受信接続をフィルタリングするファイアウォールコンポーネントを割り当てます。
HeartBeat	アイドル状態の WebSocket 接続を維持し、デッドピアを検出するために定期的な ping フレームを送信します。
Host	http.sys ドライバーに登録する URL を構築するために使用するホスト名または IP アドレス。
HTTPUploadFiles	HTTP POST 経由でアップロードされたファイルのバッファリング方法（メモリまたはファイルストリーム）とディスクへの保存を制御します。
LogFile	デバッグと監査のために、すべての受信・送信ソケットメッセージをログファイルに書き込みます。
MaxBandwidth	すべての接続にわたる 1 秒あたりの最大許容帯域幅 (バイト単位、ゼロは無制限)。
MaxConnections	http.sys リスナーが受け付ける同時クライアント接続の最大数 (ゼロは無制限を意味します)。
Options	フラグメント処理、書き込みタイムアウト、HTTPテストページ、UTF-8検証などのサーバーの様々な動作フラグをまとめます。
Port	`Host` と組み合わせてhttp.sysドライバーがサーバー用に予約するURLを形成するTCPポート。
QueueOptions	スレッド間の競合を防ぐために、内部の接続ごとのキューを通じてアウトバウンドメッセージをシリアライズします。
RateLimiter	クライアントまたは IP ごとのリクエストとメッセージレートを制限するレートリミッターコンポーネントを割り当てます。
ReadBufferSize	http.sys リクエストキューに対する保留中のオーバーラップ読み取りごとに割り当てられる受信バッファのサイズ (バイト単位)。
SecurityOptions	ブラウザの WebSocket ハンドシェイクに許可されたオリジンなどのアドミッションルールを定義します。
Specifications	サーバーが受け入れる WebSocket プロトコル仕様を有効または無効にします。
SSL	クライアントが `wss://` または `https://` を使用して接続できるよう http.sys リスナーで TLS/SSL を有効にします。
SSLOptions	SSL が有効な場合に http.sys がリスナーにバインドする Windows 証明書ストアのエントリを識別します。
ThreadPoolSize	IOCPを通じてhttp.sysリクエストキューにサービスを提供するワーカースレッドの数。
Timeouts	デフォルトの http.sys リクエスト、エンティティボディ、キープアライブ、および送信レートのタイムアウトを上書きします。
Version	バイナリに埋め込まれた sgcWebSockets ライブラリバージョンを持つ読み取り専用文字列。
WatchDog	予期しないシャットダウンまたはリスナーの障害後にサーバーを自動的に再起動します。