TsgcWebSocketLoadBalancerServerMethods › Ping

Ping メソッド

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

構文

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

パラメータ

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

解説

Pingは、アクティブな接続リストを反復処理し、ロードバランサーにアタッチされた各クライアントにWebSocket pingフレームを送信し、フレームが基盤となるソケットに渡されると戻ります。この呼び出しは、登録されたすべてのバックアップサーバーに転送されるため、リモートノードでホストされているクライアントにもpingが到達します。これは、アイドル接続を維持したり、自動HeartBeatメカニズムに加えて手動でlivenessをプローブしたりする便利な方法です。HeartBeatタイムアウトが構成されている場合、サーバーはウィンドウ内に応答しない接続を閉じます。タイムアウトがない場合、呼び出しはfire-and-forgetであり、pong応答は標準の接続イベントを通じて非同期に配信されます。書き込み中に発生した例外はOnExceptionにルーティングされます。

使用例


oServer.Ping('keepalive');

メソッドに戻る