This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.nio.channels
interface InterruptibleChannel

All Superinterfaces:
Channel, Closeable
All Known Implementing Classes:
AbstractInterruptibleChannel, FileChannel, SelectableChannel, AbstractSelectableChannel, DatagramChannel, Pipe.SinkChannel, Pipe.SourceChannel, ServerSocketChannel, SocketChannel

public interface InterruptibleChannel
extends Channel

A channel that can be asynchronously closed and interrupted.

A channel that implements this interface is asynchronously closeable: If a thread is blocked in an I/O operation on an interruptible channel then another thread may invoke the channel's {@link #close close} method. This will cause the blocked thread to receive an {@link AsynchronousCloseException}.

A channel that implements this interface is also interruptible: If a thread is blocked in an I/O operation on an interruptible channel then another thread may invoke the blocked thread's {@link Thread#interrupt() interrupt} method. This will cause the channel to be closed, the blocked thread to receive a {@link ClosedByInterruptException}, and the blocked thread's interrupt status to be set.

If a thread's interrupt status is already set and it invokes a blocking I/O operation upon a channel then the channel will be closed and the thread will immediately receive a {@link ClosedByInterruptException}; its interrupt status will remain set.

A channel supports asynchronous closing and interruption if, and only if, it implements this interface. This can be tested at runtime, if necessary, via the instanceof operator.


Method Summary
 void

          Closes this channel.
 
Methods inherited from class java.nio.channels.Channel
close, isOpen
 
Methods inherited from class java.io.Closeable
close
 

Method Detail

close

public void close()
           throws IOException
Closes this channel.

Any thread currently blocked in an I/O operation upon this channel will receive an {@link AsynchronousCloseException}.

This method otherwise behaves exactly as specified by the {@link Channel#close Channel} interface.

Throws:
IOException - If an I/O error occurs


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.