WebTransport: responseHeaders プロパティ
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能はウェブワーカー内で利用可能です。
responseHeaders は WebTransport インターフェイスの読み取り専用プロパティで、セッションを設定するリクエストに対するサーバーのレスポンスに含まれる HTTP ヘッダーを返します。
値
Headers オブジェクトです。セッションがまだ確立されていない場合は null です。
返されるオブジェクトは変更できません。set() や append() など、オブジェクトを変更するメソッドを呼び出すと TypeError が発生します。
解説
セッションは拡張 CONNECT リクエストを使用して設定されます。
クライアントは headers コンストラクターオプションを使用して、このリクエストに独自のヘッダーを追加できます。
サーバーはレスポンスにヘッダーを含めて、セッション識別子など、アプリケーション固有の情報をクライアントに返すことができます。
この値は ready プロミスが履行される前に設定されます。
返されるヘッダーには、サーバーが選択したアプリケーションプロトコルを示す WT-Protocol は含まれません。
選択されたプロトコルを取得するには、代わりに WebTransport.protocol を使用してください。
例
>レスポンスヘッダーを読み取る
この例では、セッションの設定時に独自のヘッダーを送信し、サーバーがレスポンスで返すヘッダーを読み取る方法を示します。
js
const url = "https://example.com:4999/wt";
async function initTransport(url) {
const transport = new WebTransport(url, {
// 独自のリクエストヘッダー
headers: { Authorization: "Bearer abc123" },
});
// セッション確立までは responseHeaders は null
console.log(transport.responseHeaders); // null
await transport.ready;
// すべてのレスポンスヘッダーをログに出力
for (const [name, value] of transport.responseHeaders) {
console.log(`${name}: ${value}`);
}
// 特定のヘッダーを読み取る
const sessionId = transport.responseHeaders.get("X-Session-Id");
console.log(`セッション ID: ${sessionId}`);
return transport;
}
initTransport(url);
仕様書
| 仕様書 |
|---|
| WebTransport> # dom-webtransport-responseheaders> |