AbstractInterruptibleChannel Class

Definition

[Android.Runtime.Register("java/nio/channels/spi/AbstractInterruptibleChannel", DoNotGenerateAcw=true)]
public abstract class AbstractInterruptibleChannel : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Nio.Channels.IInterruptibleChannel

[<Android.Runtime.Register("java/nio/channels/spi/AbstractInterruptibleChannel", DoNotGenerateAcw=true)>]
type AbstractInterruptibleChannel = class
    inherit Object
    interface IChannel
    interface ICloseable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface IInterruptibleChannel

Inheritance

Object

Object

AbstractInterruptibleChannel

Derived

Java.Nio.Channels.FileChannel

Java.Nio.Channels.SelectableChannel

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable ICloseable IChannel IInterruptibleChannel IDisposable

Remarks

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 begin and #end end methods before and after, respectively, invoking an I/O operation that might block indefinitely. In order to ensure that the #end end method is always invoked, these methods should be used within a try ... finally block:

<blockquote>

boolean completed = false;
            try {
                begin();
                completed = ...;    // Perform blocking I/O operation
                return ...;         // Return result
            } finally {
                end(completed);
            }

</blockquote>

The completed argument to the #end 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 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 end method will throw the appropriate exception.

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

Added in 1.4.

Java documentation for java.nio.channels.spi.AbstractInterruptibleChannel.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to