java.nio.channels.spi: abstract public class: AbstractInterruptibleChannel

java.nio.channels.spi
abstract public class: AbstractInterruptibleChannel [javadoc | source]

java.lang.Object
   java.nio.channels.spi.AbstractInterruptibleChannel

All Implemented Interfaces:
Channel, InterruptibleChannel

Direct Known Subclasses:
ReadableByteChannelImpl, WritableByteChannelImpl, AbstractSelectableChannel, ServerSocketChannel, FileChannel, SinkChannel, SourceChannel, DatagramChannel, SelectableChannel, SocketChannel

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 java.nio.channels.Channel specification. Implementations of the implCloseChannel method need not synchronize against other threads that might be attempting to close the channel.

author: Mark - Reinhold

author: JSR-51 - Expert Group

since: 1.4 -

Constructor:
protected AbstractInterruptibleChannel() { } Initializes a new instance of this class.

Constructor:

 protected AbstractInterruptibleChannel() {

}

Initializes a new instance of this class.

Method from java.nio.channels.spi.AbstractInterruptibleChannel Summary:
begin, blockedOn, close, end, implCloseChannel, isOpen

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.nio.channels.spi.AbstractInterruptibleChannel Detail:
protected final void begin() { if (interruptor == null) { interruptor = new Interruptible() { public void interrupt() { synchronized (closeLock) { if (!open) return; interrupted = true; open = false; try { AbstractInterruptibleChannel.this.implCloseChannel(); } catch (IOException x) { } } }}; } blockedOn(interruptor); if (Thread.currentThread().isInterrupted()) interruptor.interrupt(); } 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.
static void blockedOn(Interruptible intr) { // package-private sun.misc.SharedSecrets.getJavaLangAccess().blockedOn(Thread.currentThread(), intr); }
public final void close() throws IOException { synchronized (closeLock) { if (!open) return; open = false; implCloseChannel(); } } 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.
protected final void end(boolean completed) throws AsynchronousCloseException { blockedOn(null); if (completed) { interrupted = false; return; } if (interrupted) throw new ClosedByInterruptException(); if (!open) throw new AsynchronousCloseException(); } 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.
abstract protected void implCloseChannel() throws IOException 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.
public final boolean isOpen() { return open; }