ReadableStreamBYOBRequest

Интерфейс ReadableStreamBYOBRequest API потоков представляет собой «запрос данных» из базового источника, который будет передан потребителю без копирования (миновать внутренние очереди потока).

ReadableStreamBYOBRequest объекты создаются в режиме «BYOB» (блокирующего ввода-вывода), когда потребитель запрашивает данные, а внутренняя очередь потока пуста. (Поток выполнит запрос потребителя напрямую, если у него уже есть буферизованные данные). Базовый байтовый источник может получить доступ к активным запросам BYOB через свойство контроллера ReadableByteStreamController.byobRequest, которое будет установлено в значение null в случае отсутствия открытых запросов.

Базовый источник, поддерживающий режим «BYOB», должен проверять наличие ReadableByteStreamController.byobRequest и использовать его для передачи данных, если он присутствует. Если данные поступают из базового источника, когда ReadableByteStreamController.byobRequest имеет значение null, они могут быть помещены в очередь с помощью ReadableByteStreamController.enqueue(). Это может произойти, когда базовый источник получает новые данные, когда внутренние буферы потока не пусты.

Базовый источник использует запрос, записывая данные в свойство запроса BYOB view, а затем вызывая respond(), или вызывая respondWithNewView() и передавая новый фрагмент в качестве аргумента. Обратите внимание, что «новый фрагмент» должен фактически быть фрагментом того же буфера, что и исходный view, начиная с того же смещения. Это может быть использовано для возврата более короткого буфера, если базовый источник не может заполнить весь исходный фрагмент.

Обратите внимание, что ReadableByteStreamController создается только для базовых источников, когда type="bytes" указано для источника в конструкторе ReadableStream(). Режим «BYOB» включён, когда либо autoAllocateChunkSize указано в конструкторе ReadableController(), либо используется ReadableStreamBYOBReader (обычно создаваемый вызовом ReadableStream.getReader() с аргументом { mode: 'byob' }).

Нет. Экземпляр ReadableStreamBYOBRequest создаётся автоматически ReadableByteStreamController по мере необходимости.

ReadableStreamBYOBRequest.view Только для чтения

Возвращает текущий фрагмент. Это фрагмент буфера, который будет передан потребителю при вызове ReadableStreamBYOBRequest.respond().

ReadableStreamBYOBRequest.respond()

Сигнализирует связанному потоку чтения байтов, что указанное количество байтов было записано в текущий view, что приводит к выполнению ожидаемого запроса потребителя. Обратите внимание, что после вызова этого метода view передаётся и больше не может быть изменён.

ReadableStreamBYOBRequest.respondWithNewView()

Сигнализирует связанному потоку чтения байтов, что переданный в качестве аргумента фрагмент должен быть передан потребителю потока чтения байтов. Этот новый фрагмент должен использовать тот же буфер, что и исходный view, начинаться с того же смещения и иметь такую же или меньшую длину. Обратите внимание, что после вызова этого метода view передаётся и больше не может быть изменён.

Следующий код взят из примера на Использование потоков чтения байтов > Создание потока чтения байтов для сокета push.

Базовый источник на стороне «push», имеющий данные для передачи, должен сначала проверить, что controller.byobRequest не null. Базовый источник на стороне «pull» будет проверять это только в том случае, если не включена автоматическая выделение фрагментов и используется по умолчанию reader.

if (controller.byobRequest) {
  /* code to transfer data */
}

Существует два способа чтения данных в ReadableStreamBYOBRequest и их передачи. Первый — записать данные в свойство ReadableStreamBYOBRequest.view, а затем вызвать ReadableStreamBYOBRequest.respond() для указания количества передаваемых данных. После операции byobRequest.view отсоединяется, и запрос должен быть удален.

Код ниже демонстрирует этот случай, используя гипотетический метод readInto() для копирования данных в фрагмент:

const v = controller.byobRequest.view;
bytesRead = socket.readInto(v.buffer, v.byteOffset, v.byteLength);
controller.byobRequest.respond(bytesRead);

Другой подход — вызвать ReadableStreamBYOBRequest.respondWithNewView() и передать собственный фрагмент на тех же базовых данных. Обратите внимание, что это просто другой способ указания диапазона базового буфера/памяти, который фактически передаётся. respondWithNewView эквивалент кода выше:

const v = controller.byobRequest.view;
bytesRead = socket.readInto(v.buffer, v.byteOffset, v.byteLength);
const newView = new Uint8Array(v.buffer, v.byteOffset, bytesRead);
controller.byobRequest.respondWithNewView(newView);

• Использование потоков чтения байтов