|
NIO2 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AsynchronousByteChannel
An asynchronous channel that can read and write bytes.
Some channels may not allow more than one read to be outstanding at any
given time. If a thread invokes a read method before a previous read
operation has completed then a ReadPendingException
will be thrown.
Similarly, if a write method is invoked before a previous write has completed
then WritePendingException
is thrown. Whether or not other kinds of
I/O operations may proceed concurrently with a read operation depends upon
the type of the channel.
Note that ByteBuffers
are not safe for use by
multiple concurrent threads. When a read or write operation is initiated then
care must be taken to ensure that the buffer is not accessed until the
operation completes.
Channels.newInputStream(AsynchronousByteChannel)
,
Channels.newOutputStream(AsynchronousByteChannel)
Method Summary | ||
---|---|---|
Future<Integer> |
read(ByteBuffer dst)
Reads a sequence of bytes from this channel into the given buffer. |
|
|
read(ByteBuffer dst,
A attachment,
CompletionHandler<Integer,? super A> handler)
Reads a sequence of bytes from this channel into the given buffer. |
|
Future<Integer> |
write(ByteBuffer src)
Writes a sequence of bytes to this channel from the given buffer. |
|
|
write(ByteBuffer src,
A attachment,
CompletionHandler<Integer,? super A> handler)
Writes a sequence of bytes to this channel from the given buffer. |
Methods inherited from interface org.classpath.icedtea.java.nio.channels.AsynchronousChannel |
---|
close |
Methods inherited from interface java.nio.channels.Channel |
---|
isOpen |
Method Detail |
---|
<A> Future<Integer> read(ByteBuffer dst, A attachment, CompletionHandler<Integer,? super A> handler)
This method initiates an operation to read a sequence of bytes from
this channel into the given buffer. The method returns a Future
representing the pending result of the operation. The result of the
operation, obtained by invoking the Future
's get
method, is the number of bytes read or -1
if
all bytes have been read and the channel has reached end-of-stream.
This method initiates a read operation to read up to r bytes
from the channel, where r is the number of bytes remaining in the
buffer, that is, dst.remaining()
at the time that the read is
attempted. Where r is 0, the read operation completes immediately
with a result of 0
without initiating an I/O operation.
Suppose that a byte sequence of length n is read, where 0 < n <= r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p + n - 1, where p is the buffer's position at the moment the read is performed. Upon completion the buffer's position will be equal to p + n; its limit will not have changed.
Buffers are not safe for use by multiple concurrent threads so care should be taken to not to access the buffer until the operaton has completed.
This method may be invoked at any time. Some channel types may not
allow more than one read to be outstanding at any given time. If a thread
initiates a read operation before a previous read operation has
completed then a ReadPendingException
will be thrown.
The handler parameter is used to specify a CompletionHandler
. When the read operation completes the handler's
completed
method is executed.
dst
- The buffer into which bytes are to be transferredattachment
- The object to attach to the I/O operation; can be null
handler
- The completion handler object; can be null
IllegalArgumentException
- If the buffer is read-only
ReadPendingException
- If the channel does not allow more than one read to be outstanding
and a previous read has not completedFuture<Integer> read(ByteBuffer dst)
An invocation of this method of the form c.read(dst) behaves in exactly the same manner as the invocation
c.read(dst, null, null);
dst
- The buffer into which bytes are to be transferred
IllegalArgumentException
- If the buffer is read-only
ReadPendingException
- If the channel does not allow more than one read to be outstanding
and a previous read has not completed<A> Future<Integer> write(ByteBuffer src, A attachment, CompletionHandler<Integer,? super A> handler)
This method initiates an operation to write a sequence of bytes to
this channel from the given buffer. This method returns a Future
representing the pending result of the operation. The result
of the operation, obtained by invoking the Future's get
method, is the number of bytes written, possibly zero.
This method initiates a write operation to write up to r bytes
to the channel, where r is the number of bytes remaining in the
buffer, that is, src.remaining()
at the moment the write is
attempted. Where r is 0, the write operation completes immediately
with a result of 0
without initiating an I/O operation.
Suppose that a byte sequence of length n is written, where 0 < n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment the write is performed; the index of the last byte written will be p + n - 1. Upon completion the buffer's position will be equal to p + n; its limit will not have changed.
Buffers are not safe for use by multiple concurrent threads so care should be taken to not to access the buffer until the operaton has completed.
This method may be invoked at any time. Some channel types may not
allow more than one write to be outstanding at any given time. If a thread
initiates a write operation before a previous write operation has
completed then a WritePendingException
will be thrown.
The handler parameter is used to specify a CompletionHandler
. When the write operation completes the handler's
completed
method is executed.
src
- The buffer from which bytes are to be retrievedattachment
- The object to attach to the I/O operation; can be null
handler
- The completion handler object; can be null
WritePendingException
- If the channel does not allow more than one write to be outstanding
and a previous write has not completedFuture<Integer> write(ByteBuffer src)
An invocation of this method of the form c.write(src) behaves in exactly the same manner as the invocation
c.write(src, null, null);
src
- The buffer from which bytes are to be retrieved
WritePendingException
- If the channel does not allow more than one write to be outstanding
and a previous write has not completed
|
NIO2 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved.