WebTransport
Baseline 2026>
最近利用可能
*
2026年3月以降、この機能は最新のバージョンの端末およびブラウザーで動作します。古い端末やブラウザーでは動作しないことがあります。
* この機能の一部は、対応レベルにばらつきがある場合があります。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能はウェブワーカー内で利用可能です。
WebTransport はウェブトランスポート API のインターフェイスで、ユーザーエージェントが HTTP/3 サーバーに接続し、単方向または双方向で信頼性のあるトランスポートおよび信頼性のないトランスポートを開始し、接続が不要になった時点で接続を閉じるための機能を提供します。
コンストラクター
WebTransport()-
新しい
WebTransportオブジェクトのインスタンスを作成します。
静的プロパティ
supportsReliableOnly読取専用-
ブラウザーが信頼性のあるトランスポートのみを介した WebTransport セッションに対応しているかどうかを示す論理値を返します。
インスタンスプロパティ
anticipatedConcurrentIncomingBidirectionalStreams-
サーバーが同時に開いているとアプリケーションが想定する受信双方向ストリームの数を表します。
anticipatedConcurrentIncomingUnidirectionalStreams-
サーバーが同時に開いているとアプリケーションが想定する受信単方向ストリームの数を表します。
closed読取専用-
トランスポートが閉じられたときに解決する
Promiseを返します。 congestionControl読取専用-
データ送信時に、高スループットと低レイテンシーのどちらを推奨するかを示す文字列を返します。
datagrams読取専用-
データグラムの送受信に使用できる
WebTransportDatagramDuplexStreamインスタンスを返します。 draining読取専用-
トランスポートセッションのドレイン処理が開始されたときに解決する
Promiseを返します。 incomingBidirectionalStreams読取専用-
サーバーによって開かれた 1 つ以上の双方向ストリームを表します。
WebTransportBidirectionalStreamオブジェクトのReadableStreamを返します。それぞれのオブジェクトを使用して、サーバーからデータを読み込んだり、サーバーにデータを書き戻したりすることができます。 incomingUnidirectionalStreams読取専用-
サーバーによって開かれた 1 つ以上の単方向ストリームを表します。
WebTransportReceiveStreamオブジェクトのReadableStreamを返します。それぞれのオブジェクトを使用して、サーバーからデータを読み取ることができます。 protocol読取専用-
サーバーが選択したアプリケーション固有のプロトコルを表す文字列を返します。何も選択されていない場合は
""を返します。 クライアントが希望するプロトコルは、コンストラクターのprotocolsオプションで渡します。 ready読取専用-
トランスポートが使用可能になった時点で解決する
Promiseを返します。 reliability読取専用-
接続が信頼性のあるトランスポートにのみ対応しているか、それとも信頼性のないトランスポート(UDP など)にも対応しているかを示す文字列を返します。
responseHeaders読取専用-
セッションを確立するリクエストに対するサーバーのレスポンスに含まれる HTTP ヘッダーを格納する
Headersオブジェクトを返します。セッションがまだ確立されていない場合はnullを返します。
インスタンスメソッド
close()-
進行中のウェブトランスポートセッションが閉じられます。
createBidirectionalStream()-
サーバーとの間でデータの読み書きを行うために使用できる双方向ストリーム (
WebTransportBidirectionalStream) を非同期で開きます。 createSendGroup()-
ストリームとデータグラムをまとめ、それらの相対的な送信優先度をひとまとまりとして制御できる
WebTransportSendGroupを返します。 createUnidirectionalStream()-
サーバーへの書き込みに使用できる単方向ストリーム (
WritableStream) を非同期で開きます。 exportKeyingMaterial()-
接続の基礎となる TLS セッションから導出された鍵素材で履行される
Promiseを返します。 getStats()-
トランスポートの基礎となる接続の統計情報を含むオブジェクトで履行される
Promiseを返します。
例
下記のサンプルコードは、WebTransport() コンストラクターに URL を渡すことで、HTTP/3 サーバーに接続する方法を示しています。
なお、プロトコルは HTTPS である必要があり、ポート番号は明示的に指定する必要があります。
WebTransport.ready プロミスが履行されたら、接続を使用することができます。
async function initTransport(url) {
// トランスポートコネクションを初期化
const transport = new WebTransport(url);
// ready が履行されるとコネクションが利用できる
await transport.ready;
return transport;
}
接続の終了には、WebTransport.closed プロミスが履行されるのを待つことで応答できます。
WebTransport 操作によって返されるエラーは WebTransportError 型であり、標準の DOMException セットに加えて追加のデータが含まれています。
下記の closeTransport() メソッドは、その実装例を示しています。
try...catch ブロック内で await を使用し、closed プロミスが履行されるか拒否されるかを待ち、その後、接続が意図的に閉じられたのか、それともエラーによるものだったのかを報告します。
async function closeTransport(transport) {
// コネクションが閉じるのに応答
try {
await transport.closed;
console.log(`HTTP/3 による ${url} へのコネクションは正常に閉じられました。`);
} catch (error) {
console.error(`HTTP/3 による ${url} へのコネクションは ${error} で閉じられました。`);
}
}
上記の非同期関数については、下記に示すように、自分自身で別の非同期関数内で呼び出すことができます。
// transport を使用
async function useTransport(url) {
const transport = await initTransport(url);
// transport オブジェクトを使用してデータを送受信
// …
// 終了したら、トランスポートを閉じる
await closeTransport(transport);
}
const url = "https://example.com:4999/wt";
useTransport(url);
他のコード例については、各プロパティおよびメソッドのページを参照してください。
仕様書
| 仕様書 |
|---|
| WebTransport> # web-transport> |