TsgcWSAPIServer_WebPushメソッド › KeepAlive

KeepAlive メソッド

アイドル状態のリンクをプロキシを通じて開いたままにするために、単一の WebSocket 接続にキープアライブ/ping フレームを書き込む継承されたヘルパー。

構文

procedure KeepAlive(const aConnection: TsgcWSConnection; const aMessage: string);

パラメータ

名前タイプ説明
aConnectionconst TsgcWSConnectionキープアライブフレームを受信すべき、アタッチされたサーバーが保持する WebSocket 接続。
aMessageconst stringキープアライブフレーム内に運ばれるオプションのペイロード。ベアな ping には空文字列を渡してください。

解説

同じコンポーネントが、Web Push HTTPエンドポイントと並行して長寿命のWebSocketセッションも管理するシナリオのために、ベースAPIサーバークラスによって公開されます。典型的なWeb Pushトラフィックは、ブラウザのプッシュサービスへの短命なHTTPS POSTであり、キープアライブを必要としません。そのため、通常このメソッドを呼び出すのは、同じリスナーを通じてクライアントをWebSocketにアップグレードした場合のみです。

使用例

sgcWSAPIServer_WebPush1.KeepAlive(aConnection, '');

メソッドに戻る