Ping メソッド

接続されているすべてのクライアントに WebSocket ping フレームを送信します。

構文

procedure Ping(const aText: string = '');

パラメータ

名前	タイプ	説明
`aText`	`const string`	ping フレーム内に含めるオプションのペイロード。ペイロードなしで ping を送信するには空の文字列を渡してください。

解説

Pingはアクティブな接続リストを反復処理し、各クライアントにWebSocketのpingフレームを送信します。フレームが下層のソケットに渡された時点で復帰します。これは、アイドル状態の接続を維持したり、自動のHeartBeatメカニズムに加えて手動で生存確認を行ったりするのに便利な方法です。HeartBeatタイムアウトが設定されている場合、サーバーはその時間内に応答しない接続をすべて閉じます。タイムアウトがない場合、この呼び出しは送りっぱなしであり、pong応答は標準の接続イベントを通じて非同期に配信されます。書き込み中に発生した例外はOnExceptionにルーティングされます。

使用例


oServer.Ping('keepalive');

メソッドに戻る