AsynchronousSocketChannel

AsynchronousSocketChannel

protected AsynchronousSocketChannel(provider: AsynchronousChannelProvider!)

Initializes a new instance of this class.

bind

abstract fun bind(local: SocketAddress!): AsynchronousSocketChannel!

connect

abstract fun connect(remote: SocketAddress!): Future<Void!>!

Connects this channel.

This method initiates an operation to connect this channel. This method behaves in exactly the same manner as the connect(java.net.SocketAddress,java.lang.Object,java.nio.channels.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.

connect

abstract fun <A : Any!> connect(
    remote: SocketAddress!, 
    attachment: A, 
    handler: CompletionHandler<Void!, in A>!
): Unit

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.

This method performs exactly the same security checks as the class. That is, if a security manager has been installed then this method verifies that its java.lang.SecurityManager#checkConnect method permits connecting to the address and port number of the given remote endpoint.

getLocalAddress

abstract fun getLocalAddress(): SocketAddress!

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 .

If there is a security manager set, its checkConnect method is called with the local address and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, a SocketAddress representing the loopback address and the local port of the channel's socket is returned.

getRemoteAddress

abstract fun getRemoteAddress(): SocketAddress!

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 .

open

open static fun open(): AsynchronousSocketChannel!

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);
  

open

open static fun open(group: AsynchronousChannelGroup!): AsynchronousSocketChannel!

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.

provider

fun provider(): AsynchronousChannelProvider!

Returns the provider that created this channel.

read

abstract fun read(dst: ByteBuffer!): Future<Int!>!

read

fun <A : Any!> read(
    dst: ByteBuffer!, 
    attachment: A, 
    handler: CompletionHandler<Int!, in A>!
): Unit

read

abstract fun <A : Any!> read(
    dst: ByteBuffer!, 
    timeout: Long, 
    unit: TimeUnit!, 
    attachment: A, 
    handler: CompletionHandler<Int!, in A>!
): Unit

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 java.nio.channels.AsynchronousByteChannel#read(java.nio.ByteBuffer,java.lang.Object,java.nio.channels.CompletionHandler) method.

read

abstract fun <A : Any!> read(
    dsts: Array<ByteBuffer!>!, 
    offset: Int, 
    length: Int, 
    timeout: Long, 
    unit: TimeUnit!, 
    attachment: A, 
    handler: CompletionHandler<Long!, in A>!
): Unit

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.

setOption

abstract fun <T : Any!> setOption(
    name: SocketOption<T>!, 
    value: T
): AsynchronousSocketChannel!

shutdownInput

abstract fun shutdownInput(): AsynchronousSocketChannel!

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.

shutdownOutput

abstract fun shutdownOutput(): AsynchronousSocketChannel!

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.

write

abstract fun write(src: ByteBuffer!): Future<Int!>!

write

fun <A : Any!> write(
    src: ByteBuffer!, 
    attachment: A, 
    handler: CompletionHandler<Int!, in A>!
): Unit

write

abstract fun <A : Any!> write(
    src: ByteBuffer!, 
    timeout: Long, 
    unit: TimeUnit!, 
    attachment: A, 
    handler: CompletionHandler<Int!, in A>!
): Unit

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 java.nio.channels.AsynchronousByteChannel#write(java.nio.ByteBuffer,java.lang.Object,java.nio.channels.CompletionHandler) method.

write

abstract fun <A : Any!> write(
    srcs: Array<ByteBuffer!>!, 
    offset: Int, 
    length: Int, 
    timeout: Long, 
    unit: TimeUnit!, 
    attachment: A, 
    handler: CompletionHandler<Long!, in A>!
): Unit

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.