TsgcWebSocketClient › イベント › OnHandshake

OnHandshake イベント

クライアントの HTTP ハンドシェイクが構築されるときに発生し、カスタムヘッダーを追加できます。

構文

property OnHandshake: TsgcWSHandshakeEvent;
// TsgcWSHandshakeEvent = procedure(Connection: TsgcWSConnection; var Headers: TStringList) of object

デフォルト値

—

解説

OnHandshake は、HTTP アップグレードリクエストがサーバーに送信される直前にクライアントで発生します。Headers パラメータは送信されるハンドシェイクラインを含む TStringList です。追加のライン（例：カスタム認証トークンやベンダー固有のヘッダー）を追加してアップグレードリクエストに含めることができます。標準の WebSocket ヘッダー（Host、Upgrade、Connection、Sec-WebSocket-Key...）はコンポーネントによって既に設定されており、重複させないでください。

使用例

procedure OnHandshake(Connection: TsgcWSConnection; var Headers: TStringList);
begin
  Headers.Add('Client: sgcWebSockets');
end;

イベントに戻る