A pair of channels that implements a unidirectional pipe.

A pipe consists of a pair of channels: A writable sink channel and a readable source channel. Once some bytes are written to the sink channel they can be read from the source channel in exactly the order in which they were written.

Whether or not a thread writing bytes to a pipe will block until another thread reads those bytes, or some previously-written bytes, from the pipe is system-dependent and therefore unspecified. Many pipe implementations will buffer up to a certain number of bytes between the sink and source channels, but such buffering should not be assumed.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	Pipe.SinkChannel A channel representing the writable end of a `Pipe`.
public abstract static class	Pipe.SourceChannel A channel representing the readable end of a `Pipe`.

Access	Constructor and Description
protected	Pipe() Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
public static Pipe	Returns: A new pipe open() Opens a pipe.
public abstract Pipe.SinkChannel	Returns: This pipe's sink channel sink() Returns this pipe's sink channel.
public abstract Pipe.SourceChannel	Returns: This pipe's source channel source() Returns this pipe's source channel.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Pipe	back to summary
protected Pipe() Initializes a new instance of this class.

Method Detail

open back to summary

open	back to summary
public static Pipe open() throws IOException Opens a pipe. The new pipe is created by invoking the `openPipe` method of the system-wide default `java.nio.channels.spi.SelectorProvider` object. Returns:Pipe A new pipe Exceptions IOException: If an I/O error occurs

public static Pipe open() throws IOException

Opens a pipe.

The new pipe is created by invoking the openPipe method of the system-wide default java.nio.channels.spi.SelectorProvider object.

Returns:Pipe

A new pipe

Exceptions

IOException:: If an I/O error occurs

sink	back to summary
public abstract Pipe.SinkChannel sink() Returns this pipe's sink channel. Returns:Pipe.SinkChannel This pipe's sink channel

sink

back to summary

public abstract Pipe.SinkChannel sink()

Returns this pipe's sink channel.

Returns:Pipe.SinkChannel: This pipe's sink channel

source	back to summary
public abstract Pipe.SourceChannel source() Returns this pipe's source channel. Returns:Pipe.SourceChannel This pipe's source channel

source

back to summary

public abstract Pipe.SourceChannel source()

Returns this pipe's source channel.

Returns:Pipe.SourceChannel: This pipe's source channel

java.nio.channels back to summary

public abstract Class Pipe.SinkChannel

Class Inheritance

extends AbstractSelectableChannel
implements WritableByteChannel, GatheringByteChannel

java.lang.Object
java.nio.channels.spi.AbstractInterruptibleChannel
java.nio.channels.SelectableChannel
java.nio.channels.spi.AbstractSelectableChannel
java.nio.channels.Pipe.SinkChannel

All Implemented Interfaces

java.nio.channels.GatheringByteChannel, java.nio.channels.WritableByteChannel, java.nio.channels.Channel, java.io.Closeable, java.lang.AutoCloseable

Known Direct Subclasses

sun.nio.ch.SinkChannelImpl

A channel representing the writable end of a Pipe.

Since: 1.4

Constructor Summary

Access	Constructor and Description
protected	SinkChannel(SelectorProvider The selector provider provider) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
public final int	Returns: The valid-operation set validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations.

Inherited from java.nio.channels.spi.AbstractSelectableChannel:: blockingLock configureBlocking implCloseChannel implCloseSelectableChannel implConfigureBlocking isBlocking isRegistered keyFor provider register

Constructor Detail

SinkChannel	back to summary
protected SinkChannel(SelectorProvider provider) Initializes a new instance of this class. Parameters provider:SelectorProvider The selector provider

SinkChannel

back to summary

protected SinkChannel(SelectorProvider provider)

Initializes a new instance of this class.

Parameters

provider:SelectorProvider: The selector provider

Method Detail

validOps back to summary

validOps	back to summary
public final int validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations. Pipe-sink channels only support writing, so this method returns `SelectionKey#OP_WRITE`. Returns:int The valid-operation set

public final int validOps()

Implements abstract java.nio.channels.SelectableChannel.validOps.

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

Pipe-sink channels only support writing, so this method returns SelectionKey#OP_WRITE.

Returns:int: The valid-operation set

java.nio.channels back to summary

public abstract Class Pipe.SourceChannel

Class Inheritance

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

All Implemented Interfaces

java.nio.channels.ScatteringByteChannel, java.nio.channels.ReadableByteChannel, java.nio.channels.Channel, java.io.Closeable, java.lang.AutoCloseable

Known Direct Subclasses

sun.nio.ch.SourceChannelImpl

A channel representing the readable end of a Pipe.

Since: 1.4

Constructor Summary

Access	Constructor and Description
protected	SourceChannel(SelectorProvider The selector provider provider) Constructs a new instance of this class.

Method Summary

Modifier and Type	Method and Description
public final int	Returns: The valid-operation set validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations.

Inherited from java.nio.channels.spi.AbstractSelectableChannel:: blockingLock configureBlocking implCloseChannel implCloseSelectableChannel implConfigureBlocking isBlocking isRegistered keyFor provider register

Constructor Detail

SourceChannel	back to summary
protected SourceChannel(SelectorProvider provider) Constructs a new instance of this class. Parameters provider:SelectorProvider The selector provider

SourceChannel

back to summary

protected SourceChannel(SelectorProvider provider)

Constructs a new instance of this class.

Parameters

provider:SelectorProvider: The selector provider

Method Detail

validOps back to summary

validOps	back to summary
public final int validOps() Implements abstract java.nio.channels.SelectableChannel.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

public final int validOps()

Implements abstract java.nio.channels.SelectableChannel.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