TsgcWebSocketClient › Methoden › Disconnect

Disconnect Methode

Schließt die WebSocket-Verbindung synchron und blockiert den Aufrufer, bis die Trennung abgeschlossen ist oder das Timeout abläuft.

Syntax

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

Parameter

Name	Typ	Beschreibung
aTimeout	const Integer	Maximale Zeit in Millisekunden, die auf das Schließen der Verbindung gewartet wird. Standardmäßig 10000 (10 Sekunden).

Rückgabewert

True, wenn der Client innerhalb des Timeouts vollständig getrennt wurde; False, wenn das Timeout zuerst abgelaufen ist. (Boolean)

Hinweise

Disconnect ist das blockierende Gegenstück zum Setzen von Active := False. Es löscht Active und wartet dann an einem internen Ereignis, bis der Disconnect-Handshake abgeschlossen ist oder der Timeout ausgelöst wird. Wenn der Client bereits getrennt ist, gibt die Methode sofort True zurück. Wenn Options.CleanDisconnect aktiviert ist, wird ein WebSocket-Close-Frame an den Server gesendet, bevor der Socket abgebaut wird. Verwenden Sie stattdessen Stop, wenn Sie einen nicht blockierenden Disconnect aus einem sekundären Thread benötigen.

Beispiel

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

Zurück zu Methoden