TsgcWebSocketClientMethods › Connect

Connect メソッド

WebSocket 接続を同期的に開き、ハンドシェイクが完了するかタイムアウトが経過するまで呼び出し元をブロックします。

構文

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

パラメータ

名前タイプ説明
aTimeoutconst Integer接続がアクティブになるまで待機する最大時間(ミリ秒)。デフォルトは 10000(10秒)。

戻り値

True: クライアントが接続されてタイムアウト内に WebSocket ハンドシェイクが完了した場合。それ以外の場合は False。(Boolean

解説

Connect は Active := True の設定に対応するブロッキング版です。内部的に Active を設定し、接続が確立されるかタイムアウトが切れるまで内部イベントで待機します。クライアントがすでに接続されている場合、メソッドは直ちに True を返します。関数が True を返した場合、OnConnect を待たずに直ちに WriteData を呼び出せます。セカンダリスレッドから接続する非ブロッキング呼び出しが必要な場合は Start を使用します。

使用例


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

メソッドに戻る