WebTransport: draining-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 draining des WebTransport-Interface gibt ein Promise zurück, das erfüllt wird, wenn der Server angibt, dass die Transport-Sitzung vor dem Schließen in den Drain-Zustand übergehen soll.
Wert
Ein Promise, das zu undefined aufgelöst wird.
Beschreibung
Eine Sitzung wechselt in den Zustand draining, wenn sie vom Server entsprechend signalisiert wird. Dieses Signal kann gesendet werden, wenn die Sitzung (und möglicherweise die zugrunde liegende Verbindung) bald beendet wird, beispielsweise weil der Server Last auf Backend-Instanzen verteilt, eine maximale Sitzungsdauer erzwingt oder sogar neu startet. Draining ist nur eine Anfrage: Beide Endpunkte können die Sitzung weiterhin verwenden und weiterhin neue Streams öffnen oder Datagramme senden, aber es wird erwartet, dass die Anwendung ihre Arbeit abschließt und die Sitzung bald schließt.
Eine Webanwendung kann das draining-Promise verwenden, um das erwartete Herunterfahren präventiv und geordnet zu behandeln.
Sie kann beispielsweise die aktuelle Aufgabe an einem natürlichen Haltepunkt abschließen und eine neue Sitzung öffnen, um die Arbeit fortzusetzen.
Das zurückgegebene Promise wird erstellt, wenn das WebTransport-Objekt erstellt wird, und wird erfüllt, wenn die Sitzung in den Drain-Zustand wechselt.
Der Zugriff auf dieses Promise oder das Warten darauf löst keine Aktion aus; es ermöglicht lediglich, Maßnahmen zu ergreifen, wenn die Sitzung mit dem Draining beginnt, ähnlich wie das Abhören eines Ereignisses.
Beispiele
Zu einem neuen Transport wechseln, wenn Draining beginnt
In diesem Beispiel definieren wir zunächst eine Funktion initTransport(), die eine Verbindung erstellt und wartet, bis sie verwendbar ist:
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;
return transport;
}
let transport = await initTransport(url);
Anschließend definieren wir eine Funktion migrateOnDraining(), die darauf wartet, dass der Server angibt, dass die Sitzung mit dem Draining beginnen soll.
Dadurch wird ein neuer Transport erstellt und zurückgegeben sowie der alte Transport geschlossen.
async function migrateOnDraining(url, oldTransport) {
// Promise fulfills when signaled by server
await oldTransport.draining;
// Open a replacement session so the ongoing feed isn't interrupted
const newTransport = await initTransport(url);
// Switch to sending further data on newTransport instead of oldTransport
// …
// The old session is no longer needed once the new one is in use
oldTransport.close();
return newTransport;
}
// Not awaited: settles when draining starts
migrateOnDraining(url, transport).then((newTransport) => {
transport = newTransport;
});
Beachten Sie, dass wir die Sitzung oben zwar schließen, wenn Draining signalisiert wird, wir aber weiterhin den Fall behandeln müssten, dass die Sitzung durch einen anderen Mechanismus geschlossen wird.
Dieser Code wartet auf das von WebTransport.closed zurückgegebene Promise und protokolliert, ob die Sitzung geordnet oder unerwartet geschlossen wurde.
async function watchForClose(transport) {
try {
const { closeCode, reason } = await transport.closed;
console.log(`Session closed gracefully (code ${closeCode}): ${reason}`);
} catch (error) {
// The session can close abruptly, without draining being signaled first
console.error(`Session closed unexpectedly: ${error}`);
}
}
watchForClose(transport);
Spezifikationen
| Spezifikation |
|---|
| WebTransport # dom-webtransport-draining |