ReadableByteStreamController

Интерфейс ReadableByteStreamController API потоков представляет собой контроллер для потока байтов для чтения. Он позволяет управлять состоянием и внутренней очередью ReadableStream с базовым источником байтов и обеспечивает эффективную передачу данных без копирования из базового источника потребителю, когда внутренняя очередь потока пуста.

Экземпляр этого типа контроллера создается, если объект underlyingSource со свойством type="bytes" передается в качестве аргумента конструктору ReadableStream(). Объект underlyingSource также может определять функции обратного вызова start() и pull(). Они вызываются с контроллером в качестве параметра, чтобы настроить базовый источник и запросить данные по мере необходимости.

Базовый источник использует контроллер для передачи данных в поток через свойство byobRequest или метод enqueue(). byobRequest — это объект ReadableStreamBYOBRequest, представляющий ожидающий запрос от потребителя на передачу данных напрямую без копирования потребителю. Необходимо использовать byobRequest для копирования данных, если они существуют (не используйте enqueue() в этом случае)! Если базовому источнику необходимо передать данные в поток, а byobRequest является null, то источник может вызвать enqueue(), чтобы добавить данные в внутренние очереди потока.

Обратите внимание, что byobRequest создается только в режиме "BYOB", когда есть запрос от читателя и внутренняя очередь потока пуста. Режим "BYOB" активируется при использовании ReadableStreamBYOBReader (обычно создаваемого вызовом ReadableStream.getReader() с аргументом { mode: 'byob' }). Он также активируется при использовании стандартного читателя и указании autoAllocateChunkSize в конструкторе ReadableController().

Базовый байтовый источник также может использовать контроллер для close() потока, когда все данные отправлены, и сообщать об ошибках из базового источника с помощью error(). Свойство контроллера desiredSize используется для применения "обратной загрузки", информируя базовый источник о размере внутренней очереди (малые значения указывают, что очередь заполняется, что подразумевает для базового источника, что желательно приостановить или ограничить приток).

Обратите внимание, что, хотя контроллер в первую очередь используется базовым источником байтов, нет причин, по которым он не может храниться и использоваться другими частями системы для сигнализации потоку.

Нет. Экземпляры ReadableByteStreamController автоматически создаются, если объект underlyingSource со свойством type="bytes" передается в конструктор ReadableStream().

ReadableByteStreamController.byobRequest Только для чтения

Возвращает текущий запрос BYOB, или null если нет ожидающих запросов.

ReadableByteStreamController.desiredSize Только для чтения

Возвращает необходимый желаемый размер для заполнения внутренней очереди потока.

ReadableByteStreamController.close()

Закрывает связанный поток.

ReadableByteStreamController.enqueue()

Добавляет заданный фрагмент в связанный поток.

ReadableByteStreamController.error()

Вызывает ошибку при любых будущих взаимодействиях со связанным потоком.

Контроллер используется базовым источником для передачи или добавления данных в очередь, для сигнализации о том, что поток больше не содержит данных (закрыт) или возникла ошибка. Он также используется для сигнализации базовому источнику о желаемой скорости данных «сверху» с помощью desiredSize.

Пример в Использование потоков чтения байтов, в частности Создание потока чтения байтов через сокет, демонстрирует большинство из этих случаев.

• Концепции API потоков
• Использование потоков чтения байтов
• ReadableStream
• Визуализатор потоков WHATWG, для базовой визуализации потоков чтения, записи и преобразования.
• Web-streams-polyfill или sd-streams — полифилы