Skip to content

Most visited

Recently visited

navigation

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 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

Protected constructors

Pipe

Added in API level 1
Pipe ()

Initializes a new instance of this class.

Public methods

open

Added in API level 1
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
Pipe.SinkChannel sink ()

Returns this pipe's sink channel.

Returns
Pipe.SinkChannel This pipe's sink channel

source

Added in API level 1
Pipe.SourceChannel source ()

Returns this pipe's source channel.

Returns
Pipe.SourceChannel This pipe's source channel
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.