TsgcWebSocketClient › Methods › Disconnect

Disconnect メソッド

WebSocket 接続を同期的に閉じ、切断が完了するかタイムアウトが経過するまで呼び出し元をブロックします。

構文

function Disconnect(const aTimeout: Integer = 10000): Boolean;

パラメータ

名前	タイプ	説明
aTimeout	const Integer	接続が閉じられるまで待機する最大時間（ミリ秒単位）。デフォルトは 10000（10 秒）です。

戻り値

True: クライアントがタイムアウト内に完全に切断された場合。False: タイムアウトが先に切れた場合。（Boolean）

解説

Disconnectは、Active := Falseの設定に対応するブロッキング版です。Activeをクリアし、その後、切断ハンドシェイクが完了するかタイムアウトが発生するまで内部イベントで待機します。クライアントが既に切断されている場合、このメソッドは即座にTrueを返します。Options.CleanDisconnectが有効な場合、ソケットが破棄される前にWebSocketクローズフレームがサーバーに送信されます。セカンダリスレッドからの非ブロッキングな切断が必要な場合は、代わりにStopを使用してください。

使用例

if oClient.Disconnect(10000) then
  ShowMessage('Disconnected')
else
  ShowMessage('Not Disconnected');

メソッドに戻る