| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScatteringByteChannel extends ReadableByteChannel
A channel that can read bytes into a sequence of buffers.
A scattering read operation reads, in a single invocation, a sequence of bytes into one or more of a given sequence of buffers. Scattering reads are often useful when implementing network protocols or file formats that, for example, group data into segments consisting of one or more fixed-length headers followed by a variable-length body. Similar gathering write operations are defined in the {@link GatheringByteChannel} interface.
Method Summary | |
---|---|
long |
read(ByteBuffer[] dsts) Reads a sequence of bytes from this channel into the given buffers. |
long |
read(ByteBuffer[] dsts, int offset, int length) Reads a sequence of bytes from this channel into a subsequence of the given buffers. |
Methods inherited from class java.nio.channels.ReadableByteChannel |
---|
read |
Methods inherited from class java.nio.channels.Channel |
---|
close, isOpen |
Methods inherited from class java.io.Closeable |
---|
close |
Method Detail |
---|
public long read(ByteBuffer[] dsts) throws IOException
An invocation of this method of the form c.read(dsts) behaves in exactly the same manner as the invocation
c.read(dsts, 0, dsts.length);
dsts
- The buffers into which bytes are to be transferredIOException
- If some other I/O error occurspublic long read(ByteBuffer[] dsts, int offset, int length) throws IOException
An invocation of this method attempts to read up to r bytes from this channel, where r is the total number of bytes remaining the specified subsequence of the given buffer array, that is,
at the moment that this method is invoked.dsts[offset].remaining() + dsts[offset+1].remaining() + ... + dsts[offset+length-1].remaining()
Suppose that a byte sequence of length n is read, where 0 <= n <= r. Up to the first dsts[offset].remaining() bytes of this sequence are transferred into buffer dsts[offset], up to the next dsts[offset+1].remaining() bytes are transferred into buffer dsts[offset+1], and so forth, until the entire byte sequence is transferred into the given buffers. As many bytes as possible are transferred into each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.
This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.
dsts
- The buffers into which bytes are to be transferredoffset
- The offset within the buffer array of the first buffer into
which bytes are to be transferred; must be non-negative and no
larger than dsts.lengthlength
- The maximum number of buffers to be accessed; must be
non-negative and no larger than
dsts.length - offsetIOException
- If some other I/O error occurs
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |