| java.nio.channels.ScatteringByteChannel
All known Subclasses: java.nio.channels.DatagramChannel, java.nio.channels.SocketChannel, java.nio.channels.FileChannel,
| ScatteringByteChannel | | public interface ScatteringByteChannel extends ReadableByteChannel(Code) | | 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
GatheringByteChannel interface.
author:
Mark Reinhold
author:
JSR-51 Expert Group
version:
1.21, 07/05/05
since:
1.4 |
| Method Summary | |
| public long | read(ByteBuffer[] dsts, int offset, int length)
Reads a sequence of bytes from this channel into a subsequence of the
given buffers.
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,
dsts[offset].remaining()
+ dsts[offset+1].remaining()
+ ...
| | public long | read(ByteBuffer[] dsts)
Reads a sequence of bytes from this channel into the given buffers. |
| read | | public long read(ByteBuffer[] dsts, int offset, int length) throws IOException(Code) | | Reads a sequence of bytes from this channel into a subsequence of the
given buffers.
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,
dsts[offset].remaining()
+ dsts[offset+1].remaining()
+ ... + dsts[offset+length-1].remaining()
at the moment that this method is invoked.
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.
Parameters:
dsts - The buffers into which bytes are to be transferred
Parameters:
offset - The offset within the buffer array of the first buffer intowhich bytes are to be transferred; must be non-negative and nolarger than dsts.length
Parameters:
length - The maximum number of buffers to be accessed; must benon-negative and no larger thandsts.length - offset The number of bytes read, possibly zero,or -1 if the channel has reached end-of-stream
throws:
IndexOutOfBoundsException - If the preconditions on the offset and lengthparameters do not hold
throws:
NonReadableChannelException - If this channel was not opened for reading
throws:
ClosedChannelException - If this channel is closed
throws:
AsynchronousCloseException - If another thread closes this channelwhile the read operation is in progress
throws:
ClosedByInterruptException - If another thread interrupts the current threadwhile the read operation is in progress, therebyclosing the channel and setting the current thread'sinterrupt status
throws:
IOException - If some other I/O error occurs |
| read | | public long read(ByteBuffer[] dsts) throws IOException(Code) | | Reads a sequence of bytes from this channel into the given buffers.
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);
Parameters:
dsts - The buffers into which bytes are to be transferred The number of bytes read, possibly zero,or -1 if the channel has reached end-of-stream
throws:
NonReadableChannelException - If this channel was not opened for reading
throws:
ClosedChannelException - If this channel is closed
throws:
AsynchronousCloseException - If another thread closes this channelwhile the read operation is in progress
throws:
ClosedByInterruptException - If another thread interrupts the current threadwhile the read operation is in progress, therebyclosing the channel and setting the current thread'sinterrupt status
throws:
IOException - If some other I/O error occurs |
|
|