Pipe.SourceChannel

public static abstract class Pipe.SourceChannel
extends AbstractSelectableChannel implements ReadableByteChannel, ScatteringByteChannel

java.lang.Object
   ↳ java.nio.channels.spi.AbstractInterruptibleChannel
     ↳ java.nio.channels.SelectableChannel
       ↳ java.nio.channels.spi.AbstractSelectableChannel
         ↳ java.nio.channels.Pipe.SourceChannel


A channel representing the readable end of a Pipe.

Summary

Protected constructors

SourceChannel(SelectorProvider provider)

Constructs a new instance of this class.

Public methods

final int validOps()

Returns an operation set identifying this channel's supported operations.

Inherited methods

final Object blockingLock()

Retrieves the object upon which the configureBlocking and register methods synchronize.

final SelectableChannel configureBlocking(boolean block)

Adjusts this channel's blocking mode.

final void implCloseChannel()

Closes this channel.

abstract void implCloseSelectableChannel()

Closes this selectable channel.

abstract void implConfigureBlocking(boolean block)

Adjusts this channel's blocking mode.

final boolean isBlocking()

Tells whether or not every I/O operation on this channel will block until it completes.

final boolean isRegistered()

Tells whether or not this channel is currently registered with any selectors.

final SelectionKey keyFor(Selector sel)

Retrieves the key representing the channel's registration with the given selector.

final SelectorProvider provider()

Returns the provider that created this channel.

final SelectionKey register(Selector sel, int ops, Object att)

Registers this channel with the given selector, returning a selection key.

abstract Object blockingLock()

Retrieves the object upon which the configureBlocking and register methods synchronize.

abstract SelectableChannel configureBlocking(boolean block)

Adjusts this channel's blocking mode.

abstract boolean isBlocking()

Tells whether or not every I/O operation on this channel will block until it completes.

abstract boolean isRegistered()

Tells whether or not this channel is currently registered with any selectors.

abstract SelectionKey keyFor(Selector sel)

Retrieves the key representing the channel's registration with the given selector.

abstract SelectorProvider provider()

Returns the provider that created this channel.

abstract SelectionKey register(Selector sel, int ops, Object att)

Registers this channel with the given selector, returning a selection key.

final SelectionKey register(Selector sel, int ops)

Registers this channel with the given selector, returning a selection key.

abstract int validOps()

Returns an operation set identifying this channel's supported operations.

final void begin()

Marks the beginning of an I/O operation that might block indefinitely.

final void close()

Closes this channel.

final void end(boolean completed)

Marks the end of an I/O operation that might block indefinitely.

abstract void implCloseChannel()

Closes this channel.

final boolean isOpen()

Tells whether or not this channel is open.

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 timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract void close()

Closes this channel.

abstract boolean isOpen()

Tells whether or not this channel is open.

abstract void close()

Closes this channel.

abstract int read(ByteBuffer dst)

Reads a sequence of bytes from this channel into the given buffer.

abstract long read(ByteBuffer[] dsts, int offset, int length)

Reads a sequence of bytes from this channel into a subsequence of the given buffers.

abstract long read(ByteBuffer[] dsts)

Reads a sequence of bytes from this channel into the given buffers.

abstract void close()

Closes this stream and releases any system resources associated with it.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Protected constructors

SourceChannel

Added in API level 1
protected SourceChannel (SelectorProvider provider)

Constructs a new instance of this class.

Parameters
provider SelectorProvider: The selector provider

Public methods

validOps

Added in API level 1
public final int validOps ()

Returns an operation set identifying this channel's supported operations.

Pipe-source channels only support reading, so this method returns SelectionKey.OP_READ.

Returns
int The valid-operation set