Interface InterruptibleChannel
- All Superinterfaces:
-
AutoCloseable
,Channel
,Closeable
- All Known Implementing Classes:
-
AbstractInterruptibleChannel
,AbstractSelectableChannel
,DatagramChannel
,FileChannel
,Pipe.SinkChannel
,Pipe.SourceChannel
,SctpChannel
,SctpMultiChannel
,SctpServerChannel
,SelectableChannel
,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 close
method. This will cause the blocked thread to receive an 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 interrupt
method. This will cause the channel to be closed, the blocked thread to receive a 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 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.
- Since:
- 1.4
Methods
Modifier and Type | Method | Description |
---|---|---|
void | close() | Closes this channel. |
Methods declared in interface java.nio.channels.Channel
isOpen
Methods
close
void close() throws IOException
Closes this channel.
Any thread currently blocked in an I/O operation upon this channel will receive an AsynchronousCloseException
.
This method otherwise behaves exactly as specified by the Channel
interface.
- Specified by:
-
close
in interfaceAutoCloseable
- Specified by:
-
close
in interfaceChannel
- Specified by:
-
close
in interfaceCloseable
- Throws:
-
IOException
- If an I/O error occurs
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/InterruptibleChannel.html