Channel

implements Closeable

java.nio.channels.Channel

Known Indirect Subclasses

AbstractInterruptibleChannel, AbstractSelectableChannel, ByteChannel, DatagramChannel, FileChannel, GatheringByteChannel, InterruptibleChannel, Pipe.SinkChannel, Pipe.SourceChannel, ReadableByteChannel, ScatteringByteChannel, SelectableChannel, ServerSocketChannel, SocketChannel, WritableByteChannel

AbstractInterruptibleChannel	`AbstractInterruptibleChannel` is the root class for interruptible channels.
AbstractSelectableChannel	`AbstractSelectableChannel` is the base implementation class for selectable channels.
ByteChannel	A ByteChannel is both readable and writable.
DatagramChannel	A `DatagramChannel` is a selectable channel that represents a partial abstraction of a datagram socket.
FileChannel	An abstract channel type for interaction with a platform file.
GatheringByteChannel	The interface for channels that can write a set of buffers in a single operation.
InterruptibleChannel	Channels that implement this interface can be asynchronously closed and interrupted.
Pipe.SinkChannel	Writable sink channel used to write to a pipe.
Pipe.SourceChannel	Readable source channel used to read from a pipe.
ReadableByteChannel	A `ReadableByteChannel` is a type of `Channel` that can read bytes.
ScatteringByteChannel	The interface for channels that can read data into a set of buffers in a single operation.
SelectableChannel	A channel that can be used with a `Selector`.
ServerSocketChannel	A `ServerSocketChannel` is a partial abstraction of a selectable, stream-oriented listening socket.
SocketChannel	A `SocketChannel` is a selectable channel that provides a partial abstraction of stream connecting socket.
WritableByteChannel	A `WritableByteChannel` is a type of `Channel` that can write bytes.

Class Overview

A channel is a conduit to I/O services covering such items as files, sockets, hardware devices, I/O ports or some software component.

Channels are open upon creation, and can be closed explicitly. Once a channel is closed it cannot be re-opened, and any attempts to perform I/O operations on the closed channel result in a ClosedChannelException.

Particular implementations or sub-interfaces of Channel dictate whether they are thread-safe or not.

Summary

Public Methods
abstract void	close() Closes an open channel.
abstract boolean	isOpen() Returns true if this channel is open.

[Expand]

Inherited Methods

From interface java.io.Closeable

Public Methods

public abstract void close ()

Added in API level 1

Closes an open channel. If the channel is already closed then this method has no effect. If there is a problem with closing the channel then the method throws an IOException and the exception contains reasons for the failure.

If an attempt is made to perform an operation on a closed channel then a ClosedChannelException will be thrown on that attempt.

If multiple threads attempt to simultaneously close a channel, then only one thread will run the closure code, and others will be blocked until the first returns.

Throws

IOException	if a problem occurs closing the channel.

public abstract boolean isOpen ()

Added in API level 1

Returns true if this channel is open.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes