Ping メソッド

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

構文

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

パラメータ

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

解説

Pingは、アクティブな接続リストを反復処理し、アップグレードされた各クライアントにWebSocket pingフレームを送信し、フレームが基盤となるソケットに渡されると返ります。プレーンなHTTP/HTTP2接続は、WebSocketのping opcodeがハンドシェイク成功後にのみ適用されるため、スキップされます。これは、自動のHeartBeatメカニズムに加えて、アイドル接続を維持したり、手動で生存性をプローブしたりする便利な方法です。HeartBeatタイムアウトが設定されている場合、サーバーはウィンドウ内に応答しない接続を閉じます。タイムアウトがない場合、呼び出しはfire-and-forgetであり、pong応答は標準の接続イベントを通じて非同期に配信されます。書き込み中に発生した例外はOnExceptionにルーティングされます。

使用例


oServer.Ping('keepalive');

メソッドに戻る