DasReadableByteStreamController-Interface derStreams API repräsentiert einen Controller für einenlesbaren Byte-Strom.Es ermöglicht die Steuerung des Zustands und der internen Warteschlange einesReadableStream mit einer zugrundeliegenden Byte-Quelle und erlaubt eine effiziente Zero-Copy-Übertragung von Daten von der zugrundeliegenden Quelle zu einem Verbraucher, wenn die interne Warteschlange des Streams leer ist.

Eine Instanz dieses Controllertyps wird erstellt, wenn einunderlyingSource-Objekt mit der Eigenschafttype="bytes" als Argument an denReadableStream()-Konstruktor übergeben wird.DasunderlyingSource-Objekt kann auch die Callback-Funktionenstart() undpull() definieren.Diese werden mit dem Controller als Parameter aufgerufen, um die zugrundeliegende Quelle einzurichten und Daten anzufordern, wenn sie benötigt werden.

Die zugrundeliegende Quelle verwendet den Controller, um Daten dem Stream über seine EigenschaftbyobRequest oder die Methodeenqueue() bereitzustellen.byobRequest ist einReadableStreamBYOBRequest-Objekt, das eine ausstehende Anforderung von einem Verbraucher darstellt, um eine Zero-Copy-Übertragung von Daten direkt zu einem Verbraucher durchzuführen.byobRequest muss verwendet werden, um Daten zu kopieren, wenn es existiert (verwenden Sie in diesem Fall nichtenqueue())!Wenn die zugrundeliegende Quelle Daten an den Stream übergeben muss undbyobRequestnull ist, kann die Quelleenqueue() aufrufen, um die Daten zu den internen Warteschlangen des Streams hinzuzufügen.

Beachten Sie, dass derbyobRequest nur im "BYOB-Modus" erstellt wird, wenn eine Anforderung von einem Leser vorliegt und die interne Warteschlange des Streams leer ist.Der "BYOB-Modus" wird aktiviert, wenn einReadableStreamBYOBReader verwendet wird (typischerweise erstellt durch Aufrufen vonReadableStream.getReader() mit dem Argument{ mode: 'byob' }).Er wird auch aktiviert, wenn ein Standardleser verwendet wird undautoAllocateChunkSize imReadableStream()-Konstruktor angegeben ist.

Eine zugrundeliegende Byte-Quelle kann den Controller auch verwenden, um den Stream zuclose(), wenn alle Daten gesendet wurden, und Fehler von der zugrundeliegenden Quelle miterror() zu melden.Die EigenschaftdesiredSize des Controllers wird verwendet, um "Gegendruck" zu erzeugen, indem der zugrundeliegenden Quelle die Größe der internen Warteschlange mitgeteilt wird (kleine Werte zeigen an, dass die Warteschlange sich füllt, was der zugrundeliegenden Quelle signalisiert, dass es wünschenswert wäre, den Zufluss zu pausieren oder zu drosseln).

Beachten Sie, dass auch wenn der Controller primär von der zugrundeliegenden Byte-Quelle verwendet wird, es keinen Grund gibt, warum er nicht von anderen Teilen des Systems gespeichert und genutzt werden kann, um das Signal an den Stream zu senden.

Konstruktor

Keiner.ReadableByteStreamController-Instanzen werden automatisch erstellt, wenn einunderlyingSource mit der Eigenschafttype="bytes" an denReadableStream()-Konstruktor übergeben wird.

Instanzeigenschaften

ReadableByteStreamController.byobRequestSchreibgeschützt

Gibt die aktuelle BYOB-Anforderung zurück odernull, wenn keine ausstehende Anforderung vorliegt.

ReadableByteStreamController.desiredSizeSchreibgeschützt

Gibt die gewünschte Größe zurück, die erforderlich ist, um die interne Warteschlange des Streams zu füllen.

Instanzmethoden

ReadableByteStreamController.close()

Schließt den zugeordneten Stream.

ReadableByteStreamController.enqueue()

Fügt einen gegebenen Datenblock in den zugeordneten Stream ein.

ReadableByteStreamController.error()

Führt dazu, dass alle zukünftigen Interaktionen mit dem zugeordneten Stream fehlschlagen.

Beispiele

Der Controller wird von einer zugrundeliegenden Quelle verwendet, um Daten zu übertragen oder einzureihen, um zu signalisieren, dass der Stream keine Daten mehr hat (geschlossen wurde) oder einen Fehler aufgetreten ist. Er wird auch verwendet, um der zugrundeliegenden Quelle von "oberhalb im Stream" die gewünschte Datenrate mitdesiredSize zu signalisieren.

Das Beispiel inVerwendung von lesbaren Byte-Streams, insbesondereErstellen eines lesbaren Socket-Push-Byte-Streams, zeigt die meisten dieser Fälle.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Streams API-Konzepte
• Verwendung von lesbaren Byte-Streams
• ReadableStream
• Web-streams-polyfill