java.nio.channels

インタフェース GatheringByteChannel

すべてのスーパーインタフェース:

AutoCloseable, Channel, Closeable, WritableByteChannel

既知のすべての実装クラス:

DatagramChannel、FileChannel, Pipe.SinkChannel, SocketChannel

public interface GatheringByteChannel
extends WritableByteChannel

バッファーシーケンスからバイトを書き込むことができるチャネルです。

この「収集」書き込み操作では、1 回の呼び出しで、指定した 1 つ以上のバッファーシーケンスから連続する複数のバイト (バイトシーケンス) を書き込むことができます。「収集」書き込みは、通常、ネットワークプロトコルやファイル形式 (たとえば、データを 1 個以上の固定長のヘッダーと可変長の本体から成るセグメントにグループ化するようなファイル形式) を実装する際に便利です。これに類似した「分散」読み込み操作は、ScatteringByteChannel インタフェースで定義されます。

導入されたバージョン:

1.4

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
long	write(ByteBuffer[] srcs) このチャネルのバイトシーケンスを指定されたバッファーから書き出します。
long	write(ByteBuffer[] srcs, int offset, int length) このチャネルのバイトシーケンスを指定されたバッファーのサブシーケンスから書き出します。

インタフェース java.nio.channels.WritableByteChannel から継承されたメソッド

write

インタフェース java.nio.channels.Channel から継承されたメソッド

close, isOpen

メソッドの詳細

write

long write(ByteBuffer[] srcs,
         int offset,
         int length)
           throws IOException

このチャネルのバイトシーケンスを指定されたバッファーのサブシーケンスから書き出します。

このチャネルに最大 r バイトを書き込もうとします。r は、このメソッドの呼び出し時に指定されたバッファー配列の指定されたサブシーケンスに残っている合計バイト数です。

 srcs[offset].remaining()
     + srcs[offset+1].remaining()
     + ... + srcs[offset+length-1].remaining()

長さ n (0 <= n <= r) のバイトシーケンスが書き込まれるとします。このシーケンスの最初の srcs[offset].remaining() バイトまではバッファー srcs[offset] から書き込まれ、次の srcs[offset+1].remaining() バイトまではバッファー srcs[offset+1] から書き込まれます。バイトシーケンス全部が書き込まれるまで、この処理が繰り返されます。各バッファーから最大限のバイト数が書き込まれるため、更新された個々のバッファーの最終的な位置は、最終更新バッファーを除いて、このバッファーのリミットと等しくなります。

特に指定がないかぎり、要求された r バイトがすべて書き込まれると書き込み操作は終了します。チャネルの種類によっては、その状態に応じて、一部のバイトしか書き込まれない場合や、まったく書き込みが行われない場合もあります。たとえば非ブロックモードのソケットチャネルでは、ソケットの出力バッファー内のバイト数が最大書き込みバイト数になります。

このメソッドはいつでも呼び出すことができます。ただし、ほかのスレッドがこのチャネルに対して書き込み操作を開始している場合、このメソッドの呼び出しは最初の操作が終わるまでブロックされます。

パラメータ:

srcs - バイトの取得先バッファー

offset - 最初のバイトの取得先となるバッファー配列内のオフセット。srcs.length 以下の負でない値

length - アクセスされる最大バッファー数。srcs.length - offset 以下の負でない値

戻り値:

書き込まれるバイト数。ゼロの場合もある

例外:

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

NonWritableChannelException - このチャネルが書き込み可能でない場合

ClosedChannelException - このチャネルがクローズしている場合

AsynchronousCloseException - 書き込み操作の進行中に別のスレッドによってこのチャネルがクローズされた場合

ClosedByInterruptException - 書き込み中に別のスレッドからの割り込みがあったためにチャネルがクローズし、現在のスレッドの割り込みステータスが設定された場合

IOException - その他の入出力エラーが発生した場合

write

long write(ByteBuffer[] srcs)
           throws IOException

このチャネルのバイトシーケンスを指定されたバッファーから書き出します。

このメソッドを c.write(srcs) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます

 c.write(srcs, 0, srcs.length);

パラメータ:

srcs - バイトの取得先バッファー

戻り値:

書き込まれるバイト数。ゼロの場合もある

例外:

NonWritableChannelException - このチャネルが書き込み可能でない場合

ClosedChannelException - このチャネルがクローズしている場合

AsynchronousCloseException - 書き込み操作の進行中に別のスレッドによってこのチャネルがクローズされた場合

ClosedByInterruptException - 書き込み中に別のスレッドからの割り込みがあったためにチャネルがクローズし、現在のスレッドの割り込みステータスが設定された場合

IOException - その他の入出力エラーが発生した場合