Java Doc for AbstractInterruptibleChannel.java in  » 6.0-JDK-Core » io-nio » java » nio » channels » spi » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This class encapsulates the low-level machinery required to implement the asynchronous closing and interruption of channels. A concrete channel class must invoke the AbstractInterruptibleChannel.begin begin and AbstractInterruptibleChannel.end end methods before and after, respectively, invoking an I/O operation that might block indefinitely. In order to ensure that the AbstractInterruptibleChannel.end 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 AbstractInterruptibleChannel.end 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 AbstractInterruptibleChannel.implCloseChannel 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 AbstractInterruptibleChannel.end end method will throw the appropriate exception.

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

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

If the channel has already been closed then this method returns immediately.

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

This method is invoked by the AbstractInterruptibleChannel.close close method in order to perform the actual work of closing the channel.

This method should be invoked in tandem with the AbstractInterruptibleChannel.end end method, using a try ... finally block as shown above, in order to implement asynchronous closing and interruption for 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 AbstractInterruptibleChannel.implCloseChannel implCloseChannel method in order to complete the close operation.

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

This method is invoked by the AbstractInterruptibleChannel.close 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.