TsgcWebSocketClientMétodos › Connect

Connect Método

Abre la conexión WebSocket de forma síncrona y bloquea al llamador hasta que el handshake se completa o el tiempo de espera expira.

Sintaxis

function Connect(const aTimeout: Integer = 10000): Boolean; overload;
function Connect(out AError: string; const aTimeout: Integer = 10000): Boolean; overload;

Parámetros

NombreTipoDescripción
AErrorout stringDevuelve la descripción del error de conexión cuando el método falla, o una cadena vacía en caso de éxito. El mismo texto está disponible después en LastError.
aTimeoutconst IntegerTiempo máximo en milisegundos para esperar a que la conexión se active. El valor predeterminado es 10000 (10 segundos).

Valor de Retorno

True cuando el cliente está conectado y el handshake de WebSocket se completó dentro del tiempo de espera; False en caso contrario. (Boolean)

Observaciones

Connect es la contrapartida bloqueante de establecer Active := True. Establece Active internamente y luego espera en un evento interno hasta que la conexión se establece o expira el tiempo de espera. Si el cliente ya está conectado, el método devuelve True de inmediato. Cuando la función devuelve True, es seguro llamar a WriteData directamente, sin esperar a OnConnect. Utilice Start en su lugar si necesita una llamada no bloqueante que conecte desde un hilo secundario, o ConnectTask para una conexión no bloqueante de estilo future (Delphi 2010+).

La sobrecarga con un parámetro out AError se comporta de forma idéntica, pero además devuelve el motivo de un intento fallido, de modo que no se necesita ningún controlador de eventos para saber por qué la conexión no tuvo éxito. LastError se borra antes de cada intento y contiene el mismo texto después.

Ejemplo


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');

Volver a Métodos