TsgcWebSocketClient › Methods › Connect

Connect Méthode

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

Syntaxe

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

Paramètres

Nom	Type	Description
aTimeout	const Integer	Temps maximum en millisecondes pour attendre que la connexion devienne active. La valeur par défaut est 10000 (10 secondes).

Valeur de retour

True lorsque le client est connecté et que le handshake WebSocket s'est terminé dans le délai imparti ; False sinon. (Boolean)

Remarques

Connect est la contrepartie bloquante de la définition de Active := True. Il définit Active en interne puis attend sur un événement interne jusqu'à ce que la connexion soit établie ou que le timeout expire. Si le client est déjà connecté, la méthode retourne True immédiatement. Lorsque la fonction retourne True, il est sûr d'appeler WriteData immédiatement, sans attendre OnConnect. Utilisez Start à la place si vous avez besoin d'un appel non bloquant qui se connecte depuis un thread secondaire.

Exemple

oClient := TsgcWebSocketClient.Create(nil);
oClient.Host := '127.0.0.1';
oClient.Port := 80;
if oClient.Connect(5000) then
  oClient.WriteData('Hello from client')
else
  ShowMessage('Connection failed');

Retour aux méthodes