TsgcWSConnection

TsgcWSConnection はクライアント WebSocket 接続のラッパーです。このオブジェクトはサーバーまたはクライアントのイベントでアクセスできます。

 

メソッド

WriteData: クライアントにメッセージを送信します。

 

Close: 相手ピアにクローズメッセージを送信します。オプションで「CloseCode」を指定できます。デフォルトでは、送信される値は NORMAL クローズコードです。負のクローズコードを送信した場合、クローズ理由は送信されません。

 

Disconnect: サーバー側からクライアント接続を閉じます。オプションで「CloseCode」を指定できます。

 

Ping: クライアントに ping を送信します。

 

AddTCPEndOfFrame: 接続がプレーン TCP の場合、メッセージの終端を定義するバイトを設定できます。メッセージは完全に受信されるまでバッファリングされます。

 

Subscribed: 接続がカスタムチャネルをサブスクライブしているかどうかを返します。

 

Subscribe: この接続をチャンネルにサブスクライブします。後で、サーバーコンポーネントから、このチャンネルにサブスクライブしているすべての接続へメッセージをブロードキャストできます。

 

UnSubscribe: この接続のチャンネルのサブスクライブを解除します。

 

 

プロパティ

Protocol: この接続で使用されるサブプロトコルを返します。

 

IP: ピア IP アドレスを返します。

 

Port: ピアポートを返します。

 

LocalIP: ホストの IP アドレスを返します。

 

LocalPort: ホストポートを返します。

 

URL: クライアントによってリクエストされた URL を返します。

 

Guid: 接続 ID を返します。

 

HeadersRequest: リクエストで受信したヘッダーのリストを返します。

 

HeadersResponse: レスポンスとして送信されたヘッダーのリストを返します。

 

RecBytes: 受信バイト数。

 

SendBytes: 送信されたバイト数。

 

Transport: 接続のトランスポートタイプを返します:

 

trpRFC6455: 通常のWebSocket接続。

 

trpHixie76: ドラフトWebSocket仕様を使用するWebSocket接続。

 

trpFlash: Flashをフォールバックとして使用するWebSocket接続。

 

trpSSE: Server-Sent Events 接続。

 

trpTCP: プレーン TCP 接続。

 

 

TCPEndOfFrameScanBuffer: メッセージの終端を見つける方法を定義できます(トランスポートとして trpTCP を使用する場合)。

 

eofScanNone: 新しいパケットが到着するたびに OnBinary イベントが呼び出されます。

 

eofScanLatestBytes: 最新のバイトが AddTCPEndOfFrame メソッドで追加されたバイトと等しい場合、OnBinary メッセージが呼び出されます。そうでない場合、このパケットはバッファリングされます。

 

eofScanAllBytes: AddTCPEndOfFrame メソッドで追加されたバイトと等しいバイトをパケット全体で検索します。見つかった場合は OnBinary イベントが呼び出され、見つからない場合はパケットがバッファリングされます。

 

Data: ユーザーセッションデータオブジェクト。ここでオブジェクトを渡し、必要なときにいつでもアクセスできます。例えば、データベースへの接続やユーザーセッションプロパティを渡すことができます。