ReadableByteStreamController

Das ReadableByteStreamController-Interface der Streams API repräsentiert einen Controller für einen lesbaren Byte-Strom. Es ermöglicht die Steuerung des Zustands und der internen Warteschlange eines ReadableStream 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 ein underlyingSource-Objekt mit der Eigenschaft type="bytes" als Argument an den ReadableStream()-Konstruktor übergeben wird. Das underlyingSource-Objekt kann auch die Callback-Funktionen start() und pull() 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 Eigenschaft byobRequest oder die Methode enqueue() bereitzustellen. byobRequest ist ein ReadableStreamBYOBRequest-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 nicht enqueue())! Wenn die zugrundeliegende Quelle Daten an den Stream übergeben muss und byobRequest null ist, kann die Quelle enqueue() aufrufen, um die Daten zu den internen Warteschlangen des Streams hinzuzufügen.

Beachten Sie, dass der byobRequest 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 ein ReadableStreamBYOBReader verwendet wird (typischerweise erstellt durch Aufrufen von ReadableStream.getReader() mit dem Argument { mode: 'byob' }). Er wird auch aktiviert, wenn ein Standardleser verwendet wird und autoAllocateChunkSize im ReadableStream()-Konstruktor angegeben ist.

Eine zugrundeliegende Byte-Quelle kann den Controller auch verwenden, um den Stream zu close(), wenn alle Daten gesendet wurden, und Fehler von der zugrundeliegenden Quelle mit error() zu melden. Die Eigenschaft desiredSize 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.