WebTransport: datagrams プロパティ
Baseline 2026>
最近利用可能
2026年3月以降、この機能は最新のバージョンの端末およびブラウザーで動作します。古い端末やブラウザーでは動作しないことがあります。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能はウェブワーカー内で利用可能です。
datagrams は WebTransport インターフェイスの読み取り専用プロパティで、信頼性のないデータ転送であるデータグラムの送受信に使用できる WebTransportDatagramDuplexStream インスタンスを返します。
「信頼性がない」とは、データの転送が保証されず、特定の順序で到着することも保証されないという意味です。状況によっては問題なく、非常に高速にデータを届けられます。たとえば、各メッセージが直前に到着したメッセージに取って代わるため順序が重要でない、ゲームの状態の定期更新を送信する場合などです。
値
WebTransportDatagramDuplexStream オブジェクトです。
例
>送信データグラムを書き込む
このコードでは、対応している場合に createWritable() メソッドを使用して、トランスポートへのデータ書き込みに使う WebTransportDatagramsWritable インスタンスを取得します。
対応していない場合は、代わりに writable プロパティ を使用します。このプロパティは WritableStream オブジェクトを返し、ライターを使ってサーバーに送信するデータを書き込めます。
const writableStream =
typeof transport.datagrams.createWritable === "function"
? transport.datagrams.createWritable()
: transport.datagrams.writable; // 非推奨、標準外。
const writer = writableStream.getWriter();
const data1 = new Uint8Array([65, 66, 67]);
const data2 = new Uint8Array([68, 69, 70]);
await writer.ready;
writer.write(data1);
await writer.ready;
writer.write(data2);
受信データグラムを読み取る
WebTransportDatagramDuplexStream.readable プロパティは、サーバーからデータを受信するために使用できる ReadableStream オブジェクトを返します。
async function readData() {
const reader = transport.datagrams.readable.getReader();
while (true) {
const { value, done } = await reader.read();
if (done) {
break;
}
// value は Uint8Array
console.log(value);
}
}
代わりに、指定したバッファーにデータグラムを読み込むには、datagramsReadableType オプションに bytes を設定してトランスポートを構築し、ReadableStreamBYOBReader を使ってストリームを読み取ります。
WebTransport() コンストラクターの記事にあるBYOB リーダーでデータグラムを読み取る例を参照してください。
仕様書
| 仕様書 |
|---|
| WebTransport> # dom-webtransport-datagrams> |