FileDocCategorySizeDatePackage
InterruptibleChannel.javaAPI DocJava SE 5 API2138Fri Aug 26 14:57:10 BST 2005java.nio.channels

InterruptibleChannel

public interface InterruptibleChannel implements 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.

author
Mark Reinhold
author
JSR-51 Expert Group
version
1.5, 03/12/19
since
1.4

Fields Summary
Constructors Summary
Methods Summary
public voidclose()
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