Pipe.SourceChannel

AI-generated Key Takeaways

• Pipe.SourceChannel represents the readable end of a Pipe and implements ReadableByteChannel and ScatteringByteChannel.

• It supports a single operation, SelectionKey.OP_READ, for reading data.

• This class provides methods for reading a sequence of bytes into a ByteBuffer or an array of ByteBuffers.

• Pipe.SourceChannel inherits functionalities from AbstractSelectableChannel for channel management and I/O operations.

• A protected constructor is available, taking a SelectorProvider as an argument to create a new instance.

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

A channel representing the readable end of a Pipe.

Protected Constructor Summary

SourceChannel(SelectorProvider provider) Constructs a new instance of this class.

Public Method Summary

final int

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

Inherited Method Summary

From class java.nio.channels.spi.AbstractSelectableChannel

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.

From class java.nio.channels.SelectableChannel

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.

From class java.nio.channels.spi.AbstractInterruptibleChannel

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.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of 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.nio.channels.ReadableByteChannel

abstract int

read(ByteBuffer dst) Reads a sequence of bytes from this channel into the given buffer.

From interface java.nio.channels.ScatteringByteChannel

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.

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

protected SourceChannel (SelectorProvider provider)

Constructs a new instance of this class.

Parameters

provider	The selector provider

Public Methods

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

• The valid-operation set