ReadableByteStreamController

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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読取専用: ストリームの内部キューを満たすために必要な希望サイズを返します。