TsgcWebSocketClient › Methods › Disconnect

Disconnect Methode

Sluit de WebSocket-verbinding synchroon en blokkeert de aanroeper totdat de verbreking is voltooid of de timeout verstrijkt.

Syntaxis

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

Parameters

Naam	Type	Beschrijving
aTimeout	const Integer	Maximale wachttijd in milliseconden totdat de verbinding is gesloten. Standaard 10000 (10 seconden).

Retourwaarde

True wanneer de client volledig is losgekoppeld binnen de timeout; False als de timeout eerst is verstreken. (Boolean)

Opmerkingen

Disconnect is de blokkerende tegenhanger van het instellen van Active := False. Het wist Active en wacht vervolgens op een interne gebeurtenis totdat de disconnect-handshake is voltooid of de time-out wordt geactiveerd. Als de client al verbroken is, retourneert de methode onmiddellijk True. Wanneer Options.CleanDisconnect is ingeschakeld, wordt een WebSocket close-frame naar de server verzonden voordat de socket wordt afgebroken. Gebruik in plaats daarvan Stop wanneer u een niet-blokkerende verbreking vanuit een secundaire thread nodig hebt.

Voorbeeld

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

Terug naar methoden