XMLHttpRequestEventTarget: timeout-Event

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignishandler-Eigenschaft.

addEventListener("timeout", (event) => { })

ontimeout = (event) => { }

Ereignistyp

Ein ProgressEvent. Erbt von Event.

Ereigniseigenschaften

Neben den unten aufgeführten Eigenschaften sind Eigenschaften der übergeordneten Schnittstelle Event verfügbar.

lengthComputable Schreibgeschützt

Ein boolesches Flag, das anzeigt, ob die Gesamtarbeit, die zu erledigen ist, und die Menge der bereits geleisteten Arbeit durch den zugrunde liegenden Prozess berechenbar sind. Mit anderen Worten, es zeigt an, ob der Fortschritt messbar ist oder nicht.

loaded Schreibgeschützt

Ein 64-Bit-Unsigned-Integer-Wert, der die Menge der bereits vom zugrunde liegenden Prozess ausgeführten Arbeit angibt. Der Anteil der geleisteten Arbeit kann berechnet werden, indem der Wert dieser Eigenschaft durch total geteilt wird. Beim Herunterladen einer Ressource mit HTTP zählt dies nur den Body der HTTP-Nachricht und schließt Header und anderen Overhead nicht ein.

total Schreibgeschützt

Ein 64-Bit-Unsigned-Integer, der die Gesamtmenge der Arbeit darstellt, die der zugrunde liegende Prozess gerade ausführt. Beim Herunterladen einer Ressource mit HTTP ist dies die Content-Length (die Größe des Nachrichtenbodys) und schließt die Header und anderen Overhead nicht ein.

Beispiele

Verwendung mit XMLHttpRequest

const client = new XMLHttpRequest();
client.open("GET", "http://www.example.org/example.txt");
client.ontimeout = () => {
  console.error("Timeout!!");
};

client.send();

Sie könnten den Ereignishandler auch mit der addEventListener()-Methode einrichten:

client.addEventListener("timeout", () => {
  console.error("Timeout!!");
});

Verwendung mit XMLHttpRequestUpload

Sie können das timeout-Event verwenden, um einen Upload zu erkennen, der gestoppt wurde, weil er zu langsam war. Für ein vollständiges Codebeispiel, das eine Datei hochlädt und eine Fortschrittsanzeige anzeigt, siehe die Hauptseite XMLHttpRequestUpload.

Das Timeout wird auf dem XMLHttpRequest-Objekt unter Verwendung der XMLHttpRequest.timeout-Eigenschaft festgelegt.

// In case of an timeout we hide the progress bar
// Note that this event can be listened to on the xhr object too
function errorAction(event) {
  progressBar.classList.remove("visible");
  log.textContent = `Upload failed: ${event.type}`;
}
xhr.upload.addEventListener("timeout", errorAction);

Spezifikationen

Browser-Kompatibilität

api.XMLHttpRequest.timeout_event

api.XMLHttpRequestUpload.timeout_event

Siehe auch

• Verwandte Ereignisse: loadstart, load, loadend, progress, error, abort
• Überwachung des Fortschritts