DataSocketByteInputStream (クラス)
public abstract DataSocketByteInputStream {inherits ByteInputStream, DataSocketStream}
パッケージ: CURL.IO.SOCKET
直接継承しているサブクラス: DataTCPSocketByteInputStream

ByteInputStream と組み合わせた DataSocketStream と一致する DataSocket.to-InputStream によって実際に返される抽象基本クラス。


プロパティ
プロパティ 継承 DataSocketStream: client-socket, timeout
プロパティ 継承 Stream-of: non-blocking-supported?, open?, origin-url
プロパティ 継承 GenericInputStream: when-last-modified
プロパティ 継承 EventTarget: event-handlers

メソッド
async-read:ストリームから非同期に読み込みを行います。
public {DataSocketByteInputStream.async-read
out:#{Array-of byte} = null,
n:int64 = max-int64,
max-chunk-size:int = 8192,
partial?:bool = false,
append?:bool = false,
event-handler:EventHandler,
...:EventHandler
}:AsyncStreamReader
shutdown:この入力ストリームのソケットを閉じます。
public abstract {DataSocketByteInputStream.shutdown}:void
メソッド 継承 InputStream-of: close, copy-out, read, read-anys, read-one, read-one-any, to-Iterator
メソッド 継承 Stream-of: verify-open
メソッド 継承 IOEventTarget: add-timeout-event-handler, remove-event-handler-by-type
メソッド 継承 EventTarget: accepts-event-class?, add-event-handler, event-handler-present?, handle-event, remove-event-handler, verify-event
メソッド 継承 BasicEventTarget: enqueue-event
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize




プロパティ詳細


メソッド詳細
async-read (メソッド)
public {DataSocketByteInputStream.async-read
out:#{Array-of byte} = null,
n:int64 = max-int64,
max-chunk-size:int = 8192,
partial?:bool = false,
append?:bool = false,
event-handler:EventHandler,
...:EventHandler
}:AsyncStreamReader

ストリームから非同期に読み込みを行います。

プログラミング注意事項

ストリームからデータを読み込み、AsyncStreamReadEvent イベントに登録されている任意のイベント ハンドラを呼び出します。
out: Array キーワード 。作成される AsyncStreamReadEvent で使用および再利用されます。
n: 読み込む最大量を示す int64 キーワード。既定値は max-int64 で、ストリームの最後まで読み込みます。
max-chunk-size: 一度に読み込む最大量、および AsyncStreamReadEvent に提供する新しいデータ量の最大サイズを示す int キーワード。既定値は 8192 です。
partial?: n 個のアイテムが読み込まれる前、またはストリームの最後に達する前に AsyncStreamReadEvent を送信するかどうかを示す bool キーワード。つまり、読み込まれるチャンクごとにイベントを送信するかどうか、append?true の場合にチャンクごとにファイル関連イベントを送信するかどうかどうかを指定することにもなります。既定値は false です。
append?: AsyncStreamReadEvent のいずれかが新規のデータだけを受け取るか、それまでに読み込まれた全データの継続バッファを受け取るかを示す bool キーワード。さらに、out が指定されている場合は、これに追加するかまたはクリアしてから使用するかを示します。既定値は false です。
event-handler: AsyncStreamReadEvent を受け取る EventHandler。少なくとも 1 つを指定する必要があります。
...: AsyncStreamReadEvent を必須引数とする EventHandler を複数記述できます。

戻り値

非同期読み込みを制御するための AsyncStreamReader

注意事項

EventHandler は引数で指定された順序とは逆の順番で呼び出され、これを使用して、読み込みが終了したときに (イベントの exception フィールドが非 null になるか、または done? フラグが true になった場合) Stream を閉じることができます。AsyncStreamReadEvent のデータは {Array-of t} です。


shutdown (メソッド)
public abstract {DataSocketByteInputStream.shutdown}:void

この入力ストリームのソケットを閉じます。

プログラミング注意事項

呼び出された後は、このストリームは close の実行以外には何もできませんが、同じソケットの DataSocketByteOutputStream はまだ使用できます。後でこのストリームで close を呼び出す必要があります。