Interface InterruptibleChannel
-
- All Superinterfaces:
- AutoCloseable, Channel, Closeable
- All Known Implementing Classes:
- AbstractInterruptibleChannel, AbstractSelectableChannel, DatagramChannel, FileChannel, Pipe.SinkChannel, Pipe.SourceChannel, 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
closemethod. This will cause the blocked thread to receive anAsynchronousCloseException.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
interruptmethod. This will cause the channel to be closed, the blocked thread to receive aClosedByInterruptException, 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description voidclose()Closes this channel.
-
-
-
Method Detail
close
void close() throws IOExceptionCloses 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
Channelinterface.- Specified by:
-
closein interfaceAutoCloseable - Specified by:
-
closein interfaceChannel - Specified by:
-
closein interfaceCloseable - Throws:
-
IOException- If an I/O error occurs
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
