# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Methods | Inherited Methods

# AsynchronousByteChannel

`public interface AsynchronousByteChannel`
`implements AsynchronousChannel`

java.nio.channels.AsynchronousByteChannel

Known indirect subclasses AsynchronousSocketChannel
AsynchronousSocketChannel | An asynchronous channel for stream-oriented connecting sockets.

An asynchronous channel that can read and write bytes.

Some channels may not allow more than one read or write 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.

See also:

- `Channels.newInputStream(AsynchronousByteChannel)`
- `Channels.newOutputStream(AsynchronousByteChannel)`

## Summary

### Public methods
`abstract <A> void` | `read(ByteBuffer dst, A attachment, CompletionHandler<Integer, ? super A> handler)` Reads a sequence of bytes from this channel into the given buffer.
`abstract Future<Integer>` | `read(ByteBuffer dst)` Reads a sequence of bytes from this channel into the given buffer.
`abstract <A> void` | `write(ByteBuffer src, A attachment, CompletionHandler<Integer, ? super A> handler)` Writes a sequence of bytes to this channel from the given buffer.
`abstract Future<Integer>` | `write(ByteBuffer src)` Writes a sequence of bytes to this channel from the given buffer.

### Inherited methods
From interface `java.nio.channels.AsynchronousChannel`
`abstract void` | `close()` Closes this channel.
From interface `java.nio.channels.Channel`
`abstract void` | `close()` Closes this channel.
`abstract boolean` | `isOpen()` Tells whether or not this channel is open.
From interface `java.io.Closeable`
`abstract void` | `close()` Closes this stream and releases any system resources associated with it.
From interface `java.lang.AutoCloseable`
`abstract void` | `close()` Closes this resource, relinquishing any underlying resources.

## Public methods

### read

    public abstract void read (ByteBuffer dst,
                    A attachment,
                    CompletionHandler<Integer, ? super A> handler)

Reads a sequence of bytes from this channel into the given buffer.

This method initiates an asynchronous read operation to read a sequence of bytes from this channel into the given buffer. The `handler` parameter is a completion handler that is invoked when the read operation completes (or fails). The result passed to the completion handler is the number of bytes read or `-1` if no bytes could be read because the channel has reached end-of-stream.

The read operation may 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 access the buffer until the operation 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.

Parameters
`dst` | `ByteBuffer`: The buffer into which bytes are to be transferred
`attachment` | `A`: The object to attach to the I/O operation; can be `null`
`handler` | `CompletionHandler`: The completion handler

Throws
`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
`ShutdownChannelGroupException` | If the channel is associated with a `AsynchronousChannelGroup` that has terminated

### read

    public abstract Future<Integer> read (ByteBuffer dst)

Reads a sequence of bytes from this channel into the given buffer.

This method initiates an asynchronous read operation to read a sequence of bytes from this channel into the given buffer. The method behaves in exactly the same manner as the `read(ByteBuffer,Object,CompletionHandler)` method except that instead of specifying a completion handler, this method returns a `Future` representing the pending result. The `Future`'s `Future#get()` method returns the number of bytes read or `-1` if no bytes could be read because the channel has reached end-of-stream.

Parameters
`dst` | `ByteBuffer`: The buffer into which bytes are to be transferred

Returns
`Future<Integer>` | A Future representing the result of the operation

Throws
`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

### write

    public abstract void write (ByteBuffer src,
                    A attachment,
                    CompletionHandler<Integer, ? super A> handler)

Writes a sequence of bytes to this channel from the given buffer.

This method initiates an asynchronous write operation to write a sequence of bytes to this channel from the given buffer. The `handler` parameter is a completion handler that is invoked when the write operation completes (or fails). The result passed to the completion handler is the number of bytes written.

The write operation may 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 time that 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 access the buffer until the operation 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.

Parameters
`src` | `ByteBuffer`: The buffer from which bytes are to be retrieved
`attachment` | `A`: The object to attach to the I/O operation; can be `null`
`handler` | `CompletionHandler`: The completion handler object

Throws
`WritePendingException` | If the channel does not allow more than one write to be outstanding and a previous write has not completed
`ShutdownChannelGroupException` | If the channel is associated with a `AsynchronousChannelGroup` that has terminated

### write

    public abstract Future<Integer> write (ByteBuffer src)

Writes a sequence of bytes to this channel from the given buffer.

This method initiates an asynchronous write operation to write a sequence of bytes to this channel from the given buffer. The method behaves in exactly the same manner as the `write(ByteBuffer,Object,CompletionHandler)` method except that instead of specifying a completion handler, this method returns a `Future` representing the pending result. The `Future`'s `Future#get()` method returns the number of bytes written.

Parameters
`src` | `ByteBuffer`: The buffer from which bytes are to be retrieved

Returns
`Future<Integer>` | A Future representing the result of the operation

Throws
`WritePendingException` | If the channel does not allow more than one write to be outstanding and a previous write has not completed

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*