AbstractInterruptibleChannel

public abstract class AbstractInterruptibleChannel
extends Object implements Channel, InterruptibleChannel

Known Direct Subclasses FileChannel, SelectableChannel FileChannel A channel for reading, writing, mapping, and manipulating a file.  SelectableChannel A channel that can be multiplexed via a Selector.

Known Indirect Subclasses AbstractSelectableChannel, DatagramChannel, Pipe.SinkChannel, Pipe.SourceChannel, ServerSocketChannel, SocketChannel AbstractSelectableChannel Base implementation class for selectable channels.  DatagramChannel A selectable channel for datagram-oriented sockets.  Pipe.SinkChannel A channel representing the writable end of a Pipe.  Pipe.SourceChannel A channel representing the readable end of a Pipe.  ServerSocketChannel A selectable channel for stream-oriented listening sockets.  SocketChannel A selectable channel for stream-oriented connecting sockets.

Base implementation class for interruptible channels.

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

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

Summary

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long millis, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long millis) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.
From interface java.nio.channels.Channel abstract void close() Closes this channel. abstract boolean isOpen() Tells whether or not this channel is open.
From interface java.nio.channels.InterruptibleChannel abstract void close() Closes this channel.
From interface java.io.Closeable abstract void close() Closes this stream and releases any system resources associated with it.
From interface java.lang.AutoCloseable abstract void close() Closes this resource, relinquishing any underlying resources.

Protected constructors

AbstractInterruptibleChannel ()

Public methods

void close ()

boolean isOpen ()

Protected methods

void begin ()

void end (boolean completed)

void implCloseChannel ()