TsgcWebSocketClient › Méthodes › Disconnect

Disconnect Méthode

Ferme la connexion WebSocket de manière synchrone et bloque l'appelant jusqu'à ce que la déconnexion soit terminée ou que le délai expire.

Syntaxe

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

Paramètres

Nom	Type	Description
aTimeout	const Integer	Durée maximale en millisecondes pour attendre la fermeture de la connexion. Par défaut 10000 (10 secondes).

Valeur de retour

True lorsque le client a été complètement déconnecté dans le délai imparti ; False si le délai a expiré en premier. (Boolean)

Remarques

Disconnect est la contrepartie bloquante de la définition de Active := False. Il efface Active puis attend sur un événement interne jusqu'à ce que la négociation de déconnexion se termine ou que le délai d'expiration se déclenche. Si le client est déjà déconnecté, la méthode renvoie True immédiatement. Lorsque Options.CleanDisconnect est activé, une trame de fermeture WebSocket est envoyée au serveur avant la fermeture du socket. Utilisez Stop à la place lorsque vous avez besoin d'une déconnexion non bloquante depuis un thread secondaire.

Exemple

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

Retour aux méthodes