Added in API level 1

AbstractInterruptibleChannel

abstract class AbstractInterruptibleChannel : Channel, InterruptibleChannel

kotlin.Any
↳	java.nio.channels.spi.AbstractInterruptibleChannel

Known Direct Subclasses FileChannel, SelectableChannel FileChannel A channel for reading, writing, mapping, and manipulating a file. SelectableChannel A channel that can be multiplexed via a Selector.

Known Indirect Subclasses AbstractSelectableChannel, DatagramChannel, Pipe.SinkChannel, Pipe.SourceChannel, ServerSocketChannel, SocketChannel AbstractSelectableChannel Base implementation class for selectable channels. DatagramChannel A selectable channel for datagram-oriented sockets. Pipe.SinkChannel A channel representing the writable end of a Pipe. Pipe.SourceChannel A channel representing the readable end of a Pipe. ServerSocketChannel A selectable channel for stream-oriented listening sockets. SocketChannel A selectable channel for stream-oriented connecting sockets.

Base implementation class for interruptible channels.

This class encapsulates the low-level machinery required to implement the asynchronous closing and interruption of channels. A concrete channel class must invoke the begin and end methods before and after, respectively, invoking an I/O operation that might block indefinitely. In order to ensure that the end method is always invoked, these methods should be used within a try ... finally block:

boolean completed = false;
  try {
      begin();
      completed = ...;    // Perform blocking I/O operation
      return ...;         // Return result
  } finally {
      end(completed);
  }

The completed argument to the end method tells whether or not the I/O operation actually completed, that is, whether it had any effect that would be visible to the invoker. In the case of an operation that reads bytes, for example, this argument should be true if, and only if, some bytes were actually transferred into the invoker's target buffer.

A concrete channel class must also implement the implCloseChannel method in such a way that if it is invoked while another thread is blocked in a native I/O operation upon the channel then that operation will immediately return, either by throwing an exception or by returning normally. If a thread is interrupted or the channel upon which it is blocked is asynchronously closed then the channel's end method will throw the appropriate exception.

This class performs the synchronization required to implement the specification. Implementations of the implCloseChannel method need not synchronize against other threads that might be attempting to close the channel.

Summary

Protected constructors
AbstractInterruptibleChannel() Initializes a new instance of this class.

Public methods
Unit	close() Closes this channel.
Boolean	isOpen()

Protected methods
Unit	begin() Marks the beginning of an I/O operation that might block indefinitely.
Unit	end(completed: Boolean) Marks the end of an I/O operation that might block indefinitely.
abstract Unit	implCloseChannel() Closes this channel.

Protected constructors

AbstractInterruptibleChannel

Added in API level 1

protected AbstractInterruptibleChannel()

Initializes a new instance of this class.

Public methods

close

Added in API level 1

fun close(): Unit

Closes this channel.

If the channel has already been closed then this method returns immediately. Otherwise it marks the channel as closed and then invokes the implCloseChannel method in order to complete the close operation.

Exceptions
java.lang.Exception	if this resource cannot be closed
java.io.IOException	If an I/O error occurs

isOpen

Added in API level 1

fun isOpen(): Boolean

Return
Boolean	true if, and only if, this channel is open

Protected methods

begin

Added in API level 1

protected fun begin(): Unit

Marks the beginning of an I/O operation that might block indefinitely.

This method should be invoked in tandem with the end method, using a try ... finally block as shown above, in order to implement asynchronous closing and interruption for this channel.

end

Added in API level 1

protected fun end(completed: Boolean): Unit

Marks the end of an I/O operation that might block indefinitely.

This method should be invoked in tandem with the begin method, using a try ... finally block as shown above, in order to implement asynchronous closing and interruption for this channel.

Parameters
completed	Boolean: true if, and only if, the I/O operation completed successfully, that is, had some effect that would be visible to the operation's invoker

Exceptions
java.nio.channels.AsynchronousCloseException	If the channel was asynchronously closed
java.nio.channels.ClosedByInterruptException	If the thread blocked in the I/O operation was interrupted

implCloseChannel

Added in API level 1

protected abstract fun implCloseChannel(): Unit

Closes this channel.

This method is invoked by the #close method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once.

An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally.

Exceptions
java.io.IOException	If an I/O error occurs while closing the channel