Added in API level 1

Summary: Nested Classes | Protected Ctors | Methods | Inherited Methods

Pipe

public abstract class Pipe
extends Object

java.lang.Object
↳	java.nio.channels.Pipe

---

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.

Summary

Nested classes
class	Pipe.SinkChannel A channel representing the writable end of a Pipe.
class	Pipe.SourceChannel A channel representing the readable end of a Pipe.

Protected constructors
Pipe() Initializes a new instance of this class.

Public methods
static Pipe	open() Opens a pipe.
abstract Pipe.SinkChannel	sink() Returns this pipe's sink channel.
abstract Pipe.SourceChannel	source() Returns this pipe's source channel.

Inherited methods

From class java.lang.Object 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.

Protected constructors

Pipe

Added in API level 1

protected Pipe ()

Initializes a new instance of this class.

Public methods

open

Added in API level 1

public static Pipe open ()

Opens a pipe.

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

Returns
Pipe	A new pipe

Throws
IOException	If an I/O error occurs

sink

Added in API level 1

public abstract Pipe.SinkChannel sink ()

Returns this pipe's sink channel.

Returns
Pipe.SinkChannel	This pipe's sink channel

source

Added in API level 1

public abstract Pipe.SourceChannel source ()

Returns this pipe's source channel.

Returns
Pipe.SourceChannel	This pipe's source channel