const url = "https://example.com:4999/wt";
async function initTransport(url) {
// Initialize transport connection
const transport = new WebTransport(url);
// The connection can be used once ready fulfills
await transport.ready;
// …
}WebTransport API / notebook
WebTransport API
Runnable notebook: every JavaScript, HTML and CSS example on this page executes in a sandboxed local frame. Nothing leaves the browser.
// -- server.js --
import { randomBytes } from "node:crypto";
import { readFileSync } from "node:fs";
import { Http3Server } from "@fails-components/webtransport";
const allowedOrigin = "https://example.com";
const server = new Http3Server({
host: "0.0.0.0",
port: 4999,
secret: randomBytes(32).toString("hex"),
cert: readFileSync("certificate.pem", "utf8"),
privKey: readFileSync("private-key.pem", "utf8"),
});
async function acceptRequest({ header }) {
const path = header[":path"];
if (path !== "/wt") {
return { status: 404, path };
}
if (header.origin !== allowedOrigin) {
return { status: 403, path };
}
return { status: 200, path };
}
server.setRequestCallback(acceptRequest);
const sessions = server.sessionStream("/wt");
server.startServer();
await server.ready;
async function handleSession(session) {
// Add one of the server-side examples below here.
}
for await (const session of sessions) {
session.closed.catch(console.error);
session.ready.then(() => handleSession(session)).catch(console.error);
}async function closeTransport(transport) {
// Respond to connection closing
try {
await transport.closed;
console.log(`The HTTP/3 connection to ${url} closed gracefully.`);
} catch (error) {
console.error(`The HTTP/3 connection to ${url} closed due to ${error}.`);
}
}// -- server.js --
session.close({ closeCode: 0, reason: "Work complete" });
await session.closed;async function watchForDraining(transport) {
// Fulfills when the server signals that the session is draining
await transport.draining;
console.log("The session is draining: avoid opening new streams.");
}const url = "https://example.com:4999/wt";
async function initTransport(url) {
const transport = new WebTransport(url, {
protocols: ["chat", "file-transfer"],
});
try {
await transport.ready;
console.log(transport.protocol); // e.g. "chat", or "" if none was selected
return transport;
} catch (error) {
console.error(`Connection failed: ${error}`);
}
}// -- server.js --
const supportedProtocols = new Set(["chat", "file-transfer"]);
server.setRequestCallback(async (request) => {
const response = await acceptRequest(request);
if (response.status !== 200) {
return response;
}
const offeredProtocols = request.header["wt-available-protocols"] ?? [];
if (!Array.isArray(offeredProtocols)) {
return { ...response, status: 400 };
}
const selectedProtocol = offeredProtocols.find((protocol) =>
supportedProtocols.has(protocol),
);
return { ...response, selectedProtocol };
});const writer = transport.datagrams.writable.getWriter();
const data1 = new Uint8Array([65, 66, 67]);
const data2 = new Uint8Array([68, 69, 70]);
writer.write(data1);
writer.write(data2);// -- server.js --
for await (const data of session.datagrams.readable) {
console.log(data); // A Uint8Array sent by the client.
}async function readData() {
const reader = transport.datagrams.readable.getReader();
while (true) {
const { value, done } = await reader.read();
if (done) {
break;
}
// value is a Uint8Array.
console.log(value);
}
}// -- server.js --
const writer = session.datagrams.createWritable().getWriter();
try {
await writer.write(new Uint8Array([65, 66, 67]));
await writer.write(new Uint8Array([68, 69, 70]));
} finally {
writer.releaseLock();
}async function writeData() {
const stream = await transport.createUnidirectionalStream();
const writer = stream.getWriter();
const data1 = new Uint8Array([65, 66, 67]);
const data2 = new Uint8Array([68, 69, 70]);
writer.write(data1);
writer.write(data2);
try {
await writer.close();
console.log("All data has been sent.");
} catch (error) {
console.error(`An error occurred: ${error}`);
}
}// -- server.js --
async function receiveStream(stream) {
for await (const data of stream) {
console.log(data); // A Uint8Array sent by the client.
}
}
for await (const stream of session.incomingUnidirectionalStreams) {
receiveStream(stream).catch(console.error);
}async function readData(receiveStream) {
const reader = receiveStream.getReader();
while (true) {
const { done, value } = await reader.read();
if (done) {
break;
}
// value is a Uint8Array
console.log(value);
}
}async function receiveUnidirectional() {
const uds = transport.incomingUnidirectionalStreams;
const reader = uds.getReader();
while (true) {
const { done, value } = await reader.read();
if (done) {
break;
}
// value is an instance of WebTransportReceiveStream
await readData(value);
}
}// -- server.js --
const stream = await session.createUnidirectionalStream();
const writer = stream.getWriter();
await writer.write(new Uint8Array([65, 66, 67]));
await writer.write(new Uint8Array([68, 69, 70]));
await writer.close();async function setUpBidirectional() {
const stream = await transport.createBidirectionalStream();
// stream is a WebTransportBidirectionalStream
// stream.readable is a WebTransportReceiveStream
const readable = stream.readable;
// stream.writable is a WebTransportSendStream
const writable = stream.writable;
// …
return stream;
}async function readData(readable) {
const reader = readable.getReader();
while (true) {
const { value, done } = await reader.read();
if (done) {
break;
}
// value is a Uint8Array.
console.log(value);
}
}async function writeData(writable) {
const writer = writable.getWriter();
const data1 = new Uint8Array([65, 66, 67]);
const data2 = new Uint8Array([68, 69, 70]);
await writer.write(data1);
await writer.write(data2);
await writer.close();
}const stream = await setUpBidirectional();
await Promise.all([readData(stream.readable), writeData(stream.writable)]);// -- server.js --
for await (const stream of session.incomingBidirectionalStreams) {
// Echo received bytes back to the client. Each stream is handled separately.
stream.readable.pipeTo(stream.writable).catch(console.error);
}async function receiveBidirectional() {
const bds = transport.incomingBidirectionalStreams;
const reader = bds.getReader();
while (true) {
const { done, value } = await reader.read();
if (done) {
break;
}
// value is an instance of WebTransportBidirectionalStream
await readData(value.readable);
await writeData(value.writable);
}
}// -- server.js --
const stream = await session.createBidirectionalStream();
const writer = stream.writable.getWriter();
await writer.write(new Uint8Array([65, 66, 67]));
await writer.close();
for await (const data of stream.readable) {
console.log(data); // The client's reply.
}