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 Close 帧。当需要从辅助线程进行非阻塞断开时，请改用 Stop。

示例

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

返回方法