TsgcWebSocketServer_HTTPAPI › イベント › OnDisconnect

OnDisconnect イベント

クライアントとのWebSocket接続が切断されるたびに発生します。

構文

property OnDisconnect: TsgcWSDisconnectEvent;
// TsgcWSDisconnectEvent = procedure(Connection: TsgcWSConnection; Code: Integer) of object

デフォルト値

—

解説

OnDisconnect は、アクティブなクライアントセッションが終了したときに発生します。アプリケーションが Disconnect または DisconnectAll を呼び出した場合、クライアントが接続を閉じた場合、または基盤となる HTTP.SYS リクエストが終了した場合です。Code パラメータはピアが報告した WebSocket クローズコードを持ちます (正常なクローズの場合は 1000、異常なドロップの場合は 1006 など)。このイベントが返ると、Connection オブジェクトはデータ送信には無効になりますので、その Guid に関連付けたセッションごとのリソースを解放してください。

使用例

procedure OnDisconnect(Connection: TsgcWSConnection; Code: Integer);
begin
  Log(Format('Client %s disconnected (code %d)', [Connection.Guid, Code]));
end;

イベントに戻る