public abstract Class AsynchronousSocketChannel

Redeclares java.nio.channels.NetworkChannel.bind.

Doc from java.nio.channels.NetworkChannel.bind.

Binds the channel's socket to a local address.

This method is used to establish an association between the socket and a local address. Once an association is established then the socket remains bound until the channel is closed. If the local parameter has the value null then the socket will be bound to an address that is assigned automatically.

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs

ConnectionPendingException:

If a connection operation is already in progress on this channel

AlreadyBoundException:

If the socket is already bound

UnsupportedAddressTypeException:

If the type of the given address is not supported

ClosedChannelException:

If the channel is closed

Connects this channel.

This method initiates an operation to connect this channel. The handler parameter is a completion handler that is invoked when the connection is successfully established or connection cannot be established. If the connection cannot be established then the channel is closed.

Parameters

<A>

The type of the attachment

remote:SocketAddress

The remote address to which this channel is to be connected

attachment:A

The object to attach to the I/O operation; can be null

handler:CompletionHandler<Void, ? super A>

The handler for consuming the result

Exceptions

UnresolvedAddressException:

If the given remote address is not fully resolved

UnsupportedAddressTypeException:

If the type of the given remote address is not supported

AlreadyConnectedException:

If this channel is already connected

ConnectionPendingException:

If a connection operation is already in progress on this channel

ShutdownChannelGroupException:

If the channel group has terminated

See Also

getRemoteAddress

Connects this channel.

This method initiates an operation to connect this channel. This method behaves in exactly the same manner as the connect(SocketAddress, Object, CompletionHandler) method except that instead of specifying a completion handler, this method returns a Future representing the pending result. The Future's get method returns null on successful completion.

Parameters

remote:SocketAddress

The remote address to which this channel is to be connected

Returns:Future<Void>

A Future object representing the pending result

Exceptions

UnresolvedAddressException:

If the given remote address is not fully resolved

UnsupportedAddressTypeException:

If the type of the given remote address is not supported

AlreadyConnectedException:

If this channel is already connected

ConnectionPendingException:

If a connection operation is already in progress on this channel

Redeclares java.nio.channels.NetworkChannel.getLocalAddress.

Doc from java.nio.channels.NetworkChannel.getLocalAddress.

Returns the socket address that this channel's socket is bound to.

Where the channel is bound to an Internet Protocol socket address then the return value from this method is of type java.net.InetSocketAddress.

Returns:SocketAddress

The SocketAddress that the socket is bound to; null if the channel's socket is not bound

Exceptions

IOException:

If an I/O error occurs

ClosedChannelException:

If the channel is closed

Returns the remote address to which this channel's socket is connected.

Where the channel is bound and connected to an Internet Protocol socket address then the return value from this method is of type java.net.InetSocketAddress.

Returns:SocketAddress

The remote address; null if the channel's socket is not connected

Exceptions

IOException:

If an I/O error occurs

ClosedChannelException:

If the channel is closed

Opens an asynchronous socket channel.

The new channel is created by invoking the openAsynchronousSocketChannel method on the AsynchronousChannelProvider that created the group. If the group parameter is null then the resulting channel is created by the system-wide default provider, and bound to the default group.

Parameters

group:AsynchronousChannelGroup

The group to which the newly constructed channel should be bound, or null for the default group

Returns:AsynchronousSocketChannel

A new asynchronous socket channel

Exceptions

IOException:

If an I/O error occurs

ShutdownChannelGroupException:

If the channel group is shutdown

Opens an asynchronous socket channel.

This method returns an asynchronous socket channel that is bound to the default group.This method is equivalent to evaluating the expression:

open((AsynchronousChannelGroup)null);

Returns:AsynchronousSocketChannel

A new asynchronous socket channel

Exceptions

IOException:

If an I/O error occurs

Returns the provider that created this channel.

Returns:AsynchronousChannelProvider

The provider that created this channel

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.

If a timeout is specified and the timeout elapses before the operation completes then the operation completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been read, or will not be read from the channel into the given buffer, then further attempts to read from the channel will cause an unspecific runtime exception to be thrown.

Otherwise this method works in the same manner as the AsynchronousByteChannel#read(ByteBuffer, Object, CompletionHandler) method.

Parameters

<A>

The type of the attachment

dst:ByteBuffer

The buffer into which bytes are to be transferred

timeout:long

The maximum time for the I/O operation to complete

unit:TimeUnit

The time unit of the timeout argument

attachment:A

The object to attach to the I/O operation; can be null

handler:CompletionHandler<Integer, ? super A>

The handler for consuming the result

Exceptions

IllegalArgumentException:

If the buffer is read-only or a view of a MemorySegment allocated from a thread-confined arena

ReadPendingException:

If a read operation is already in progress on this channel

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated

Implements java.nio.channels.AsynchronousByteChannel.read.

Doc from java.nio.channels.AsynchronousByteChannel.read.

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.

Annotations

@Override

Exceptions

IllegalArgumentException:

If the buffer is read-only or a view of a MemorySegment allocated from a thread-confined arena

ReadPendingException:

If the channel does not allow more than one read to be outstanding and a previous read has not completed

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated

Redeclares java.nio.channels.AsynchronousByteChannel.read.

Doc from java.nio.channels.AsynchronousByteChannel.read.

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 get method returns the number of bytes read or -1 if no bytes could be read because the channel has reached end-of-stream.

Annotations

@Override

Exceptions

IllegalArgumentException:

If the buffer is read-only or a view of a MemorySegment allocated from a thread-confined arena

ReadPendingException:

If the channel does not allow more than one read to be outstanding and a previous read has not completed

NotYetConnectedException:

If this channel is not yet connected

Reads a sequence of bytes from this channel into a subsequence of the given buffers. This operation, sometimes called a scattering read, is often useful when implementing network protocols that group data into segments consisting of one or more fixed-length headers followed by a variable-length body. 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.

This method initiates a read of up to r bytes from this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

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. The underlying operating system may impose a limit on the number of buffers that may be used in an I/O operation. Where the number of buffers (with bytes remaining), exceeds this limit, then the I/O operation is performed with the maximum number of buffers allowed by the operating system.

If a timeout is specified and the timeout elapses before the operation completes then it completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been read, or will not be read from the channel into the given buffers, then further attempts to read from the channel will cause an unspecific runtime exception to be thrown.

Parameters

<A>

The type of the attachment

dsts:ByteBuffer[]

The buffers into which bytes are to be transferred

offset:int

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.length

length:int

The maximum number of buffers to be accessed; must be non-negative and no larger than dsts.length - offset

timeout:long

The maximum time for the I/O operation to complete

unit:TimeUnit

The time unit of the timeout argument

attachment:A

The object to attach to the I/O operation; can be null

handler:CompletionHandler<Long, ? super A>

The handler for consuming the result

Exceptions

IndexOutOfBoundsException:

If the pre-conditions for the offset and length parameter aren't met

IllegalArgumentException:

If any of the buffers is read-only or a view of a MemorySegment allocated from a thread-confined arena

ReadPendingException:

If a read operation is already in progress on this channel

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated

Redeclares java.nio.channels.NetworkChannel.setOption.

Doc from java.nio.channels.NetworkChannel.setOption.

Sets the value of a socket option.

Annotations

@Override

Exceptions

IOException:

If an I/O error occurs

IllegalArgumentException:

If the value is not a valid value for this socket option

ClosedChannelException:

If this channel is closed

Shutdown the connection for reading without closing the channel.

Once shutdown for reading then further reads on the channel will return -1, the end-of-stream indication. If the input side of the connection is already shutdown then invoking this method has no effect. The effect on an outstanding read operation is system dependent and therefore not specified. The effect, if any, when there is data in the socket receive buffer that has not been read, or data arrives subsequently, is also system dependent.

Returns:AsynchronousSocketChannel

The channel

Exceptions

IOException:

If some other I/O error occurs

NotYetConnectedException:

If this channel is not yet connected

ClosedChannelException:

If this channel is closed

Shutdown the connection for writing without closing the channel.

Once shutdown for writing then further attempts to write to the channel will throw ClosedChannelException. If the output side of the connection is already shutdown then invoking this method has no effect. The effect on an outstanding write operation is system dependent and therefore not specified.

Returns:AsynchronousSocketChannel

The channel

Exceptions

IOException:

If some other I/O error occurs

NotYetConnectedException:

If this channel is not yet connected

ClosedChannelException:

If this channel is closed

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.

If a timeout is specified and the timeout elapses before the operation completes then it completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been written, or will not be written to the channel from the given buffer, then further attempts to write to the channel will cause an unspecific runtime exception to be thrown.

Otherwise this method works in the same manner as the AsynchronousByteChannel#write(ByteBuffer, Object, CompletionHandler) method.

Parameters

<A>

The type of the attachment

src:ByteBuffer

The buffer from which bytes are to be retrieved

timeout:long

The maximum time for the I/O operation to complete

unit:TimeUnit

The time unit of the timeout argument

attachment:A

The object to attach to the I/O operation; can be null

handler:CompletionHandler<Integer, ? super A>

The handler for consuming the result

Exceptions

IllegalArgumentException:

If the buffer is a view of a MemorySegment allocated from a thread-confined arena

WritePendingException:

If a write operation is already in progress on this channel

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated

Implements java.nio.channels.AsynchronousByteChannel.write.

Doc from java.nio.channels.AsynchronousByteChannel.write.

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.

Annotations

@Override

Exceptions

IllegalArgumentException:

If the buffer is a view of a MemorySegment allocated from a thread-confined arena

WritePendingException:

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

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated

Redeclares java.nio.channels.AsynchronousByteChannel.write.

Doc from java.nio.channels.AsynchronousByteChannel.write.

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 get method returns the number of bytes written.

Annotations

@Override

Exceptions

IllegalArgumentException:

If the buffer is a view of a MemorySegment allocated from a thread-confined arena

WritePendingException:

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

NotYetConnectedException:

If this channel is not yet connected

Writes a sequence of bytes to this channel from a subsequence of the given buffers. This operation, sometimes called a gathering write, is often useful when implementing network protocols that group data into segments consisting of one or more fixed-length headers followed by a variable-length body. 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.

This method initiates a write of up to r bytes to this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

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

Suppose that a byte sequence of length n is written, where 0 < n <= r. Up to the first srcs[offset].remaining() bytes of this sequence are written from buffer srcs[offset], up to the next srcs[offset+1].remaining() bytes are written from buffer srcs[offset+1], and so forth, until the entire byte sequence is written. As many bytes as possible are written from 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. The underlying operating system may impose a limit on the number of buffers that may be used in an I/O operation. Where the number of buffers (with bytes remaining), exceeds this limit, then the I/O operation is performed with the maximum number of buffers allowed by the operating system.

If a timeout is specified and the timeout elapses before the operation completes then it completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been written, or will not be written to the channel from the given buffers, then further attempts to write to the channel will cause an unspecific runtime exception to be thrown.

Parameters

<A>

The type of the attachment

srcs:ByteBuffer[]

The buffers from which bytes are to be retrieved

offset:int

The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

length:int

The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

timeout:long

The maximum time for the I/O operation to complete

unit:TimeUnit

The time unit of the timeout argument

attachment:A

The object to attach to the I/O operation; can be null

handler:CompletionHandler<Long, ? super A>

The handler for consuming the result

Exceptions

IllegalArgumentException:

If any of the buffers is a view of a MemorySegment allocated from a thread-confined arena

IndexOutOfBoundsException:

If the pre-conditions for the offset and length parameter aren't met

WritePendingException:

If a write operation is already in progress on this channel

NotYetConnectedException:

If this channel is not yet connected

ShutdownChannelGroupException:

If the channel group has terminated