TsgcWebSocketClient プロパティ

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

接続

名前	説明
Active	設定されたサーバーへの WebSocket 接続を開くか閉じます。
Host	クライアントが接続する WebSocket サーバーの IP アドレスまたは DNS 名。
Port	WebSocket サーバーへの接続に使用する TCP ポート。
URL	単一のWebSocket URLからHost、Port、TLSおよびパラメータを設定する書き込み専用のショートカットです。
TLS	WebSocketサーバーへのセキュアなTLS/SSL接続を有効にします。
IPVersion	TCP 接続に使用される IP プロトコルバージョン (IPv4 または IPv6) を選択します。

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

名前	説明
ConnectTimeout	TCP 接続が確立されるまでクライアントが待機する最大時間（ミリ秒）。
ReadTimeout	クライアントが受信データを待機する最大時間 (ミリ秒単位)。この時間を超えると読み取りタイムアウトが発生します。
WriteTimeout	他のピアにデータを送信するための最大時間（ミリ秒単位）。

信頼性

名前	説明
HeartBeat	接続を維持するために定期的に WebSocket ping フレームを送信します。
WatchDog	予期しない切断後にサーバーへ自動的に再接続します。

セキュリティ

名前	説明
Proxy	HTTP または SOCKS プロキシサーバーを通じて WebSocket 接続をルーティングします。
Authentication	WebSocket ハンドシェイクの認証に使用される認証情報とスキームを設定します。
TLSOptions	TLS が有効な場合に使用される証明書、TLS バージョン、ALPN、IOHandler、その他のセキュア接続の詳細を設定します。

メッセージング

名前	説明
QueueOptions	送信テキスト、バイナリ、Ping メッセージをキューに入れ、接続スレッドでシリアライズします。

診断

名前	説明
NotifyEvents	WebSocket イベントをメインスレッドへディスパッチする方法を制御します。
LogFile	受信および送信ソケットトラフィックをファイルに永続化します。ワイヤープロトコルのデバッグに便利です。
Version	現在の sgcWebSockets ライブラリバージョンを返す読み取り専用の文字列。

詳細設定

名前	説明
Extensions	メッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を有効にします。
Options	ハンドシェイクヘッダーをカスタマイズし、フラグメンテーションや UTF-8 検証などのクライアントの動作を微調整します。
Specifications	クライアントがネゴシエートできる WebSocket ワイヤー仕様を選択します。
Throttle	クライアントソケットが送受信できる1秒あたりのビット数を制限します。

その他

名前	説明
LoadBalancer	sgcWebSockets ロードバランサーサーバーまたは手動で定義された WebSocket サーバーのプールに接続します。

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

名前	説明
Active	設定されたサーバーへの WebSocket 接続を開くか閉じます。
Authentication	WebSocket ハンドシェイクの認証に使用される認証情報とスキームを設定します。
ConnectTimeout	TCP 接続が確立されるまでクライアントが待機する最大時間（ミリ秒）。
Extensions	メッセージごとのデフレート圧縮などの WebSocket プロトコル拡張を有効にします。
HeartBeat	接続を維持するために定期的に WebSocket ping フレームを送信します。
Host	クライアントが接続する WebSocket サーバーの IP アドレスまたは DNS 名。
IPVersion	TCP 接続に使用される IP プロトコルバージョン (IPv4 または IPv6) を選択します。
LoadBalancer	sgcWebSockets ロードバランサーサーバーまたは手動で定義された WebSocket サーバーのプールに接続します。
LogFile	受信および送信ソケットトラフィックをファイルに永続化します。ワイヤープロトコルのデバッグに便利です。
NotifyEvents	WebSocket イベントをメインスレッドへディスパッチする方法を制御します。
Options	ハンドシェイクヘッダーをカスタマイズし、フラグメンテーションや UTF-8 検証などのクライアントの動作を微調整します。
Port	WebSocket サーバーへの接続に使用する TCP ポート。
Proxy	HTTP または SOCKS プロキシサーバーを通じて WebSocket 接続をルーティングします。
QueueOptions	送信テキスト、バイナリ、Ping メッセージをキューに入れ、接続スレッドでシリアライズします。
ReadTimeout	クライアントが受信データを待機する最大時間 (ミリ秒単位)。この時間を超えると読み取りタイムアウトが発生します。
Specifications	クライアントがネゴシエートできる WebSocket ワイヤー仕様を選択します。
Throttle	クライアントソケットが送受信できる1秒あたりのビット数を制限します。
TLS	WebSocketサーバーへのセキュアなTLS/SSL接続を有効にします。
TLSOptions	TLS が有効な場合に使用される証明書、TLS バージョン、ALPN、IOHandler、その他のセキュア接続の詳細を設定します。
URL	単一のWebSocket URLからHost、Port、TLSおよびパラメータを設定する書き込み専用のショートカットです。
Version	現在の sgcWebSockets ライブラリバージョンを返す読み取り専用の文字列。
WatchDog	予期しない切断後にサーバーへ自動的に再接続します。
WriteTimeout	他のピアにデータを送信するための最大時間（ミリ秒単位）。