WebTransport: responseHeaders-Eigenschaft
Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die schreibgeschützte Eigenschaft responseHeaders der WebTransport-Schnittstelle gibt die HTTP-Header aus der Antwort des Servers auf die Anfrage zurück, mit der die Sitzung eingerichtet wurde.
Wert
Ein Headers-Objekt oder null, wenn die Sitzung noch nicht eingerichtet wurde.
Das zurückgegebene Objekt ist unveränderlich: Der Aufruf von Methoden, die es verändern, etwa set() oder append(), löst einen TypeError aus.
Beschreibung
Die Sitzung wird mit einer erweiterten CONNECT-Anfrage eingerichtet.
Der Client kann dieser Anfrage über die Konstruktoroption headers benutzerdefinierte Header hinzufügen.
Der Server kann in seine Antwort Header aufnehmen, um anwendungsspezifische Informationen wie eine Sitzungskennung an den Client zurückzugeben.
Der Wert wird gesetzt, bevor das ready-Promise erfüllt wird.
Die zurückgegebenen Header enthalten nicht WT-Protocol, mit dem der Server das von ihm gewählte Anwendungsprotokoll angibt.
Verwenden Sie stattdessen WebTransport.protocol, um das ausgewählte Protokoll abzurufen.
Beispiele
Antwort-Header auslesen
Dieses Beispiel zeigt, wie Sie beim Einrichten einer Sitzung einen benutzerdefinierten Header senden und anschließend einen Header aus der Antwort des Servers auslesen können.
const url = "https://example.com:4999/wt";
async function initTransport(url) {
const transport = new WebTransport(url, {
// Custom request headers
headers: { Authorization: "Bearer abc123" },
});
// responseHeaders is null until the session is established
console.log(transport.responseHeaders); // null
await transport.ready;
// Log all the response headers
for (const [name, value] of transport.responseHeaders) {
console.log(`${name}: ${value}`);
}
// Read a specific header
const sessionId = transport.responseHeaders.get("X-Session-Id");
console.log(`Session ID: ${sessionId}`);
return transport;
}
initTransport(url);
Spezifikationen
| Spezifikation |
|---|
| WebTransport # dom-webtransport-responseheaders |