# Pipe

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Nested Classes](https://developer.android.com/reference/java/nio/channels/Pipe#nestedclasses)\|[Protected Ctors](https://developer.android.com/reference/java/nio/channels/Pipe#proctors)\|[Methods](https://developer.android.com/reference/java/nio/channels/Pipe#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/java/nio/channels/Pipe#inhmethods)  

# Pipe

`
public


abstract
class
Pipe
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.nio.channels.Pipe |

<br />

*** ** * ** ***

A pair of channels that implements a unidirectional pipe.

A pipe consists of a pair of channels: A writable[sink](https://developer.android.com/reference/java/nio/channels/Pipe.SinkChannel)channel and a readable[source](https://developer.android.com/reference/java/nio/channels/Pipe.SourceChannel)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.

<br />

## Summary

|                                                                                                        ### Nested classes                                                                                                        ||
|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [Pipe.SinkChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SinkChannel) A channel representing the writable end of a[Pipe](https://developer.android.com/reference/java/nio/channels/Pipe).     |
| ` class` | [Pipe.SourceChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SourceChannel) A channel representing the readable end of a[Pipe](https://developer.android.com/reference/java/nio/channels/Pipe). |

|                                                     ### Protected constructors                                                     ||
|---------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[Pipe](https://developer.android.com/reference/java/nio/channels/Pipe#Pipe())`() ` Initializes a new instance of this class. |

|                                                                                                              ### Public methods                                                                                                               ||
|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| ` static `[Pipe](https://developer.android.com/reference/java/nio/channels/Pipe)                               | ` `[open](https://developer.android.com/reference/java/nio/channels/Pipe#open())`() ` Opens a pipe.                           |
| ` abstract `[Pipe.SinkChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SinkChannel)     | ` `[sink](https://developer.android.com/reference/java/nio/channels/Pipe#sink())`() ` Returns this pipe's sink channel.       |
| ` abstract `[Pipe.SourceChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SourceChannel) | ` `[source](https://developer.android.com/reference/java/nio/channels/Pipe#source())`() ` Returns this pipe's source channel. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
protected Pipe ()
```

Initializes a new instance of this class.

<br />

## Public methods

### open

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static Pipe open ()
```

Opens a pipe.

The new pipe is created by invoking the[openPipe](https://developer.android.com/reference/java/nio/channels/spi/SelectorProvider#openPipe())method of the system-wide default[SelectorProvider](https://developer.android.com/reference/java/nio/channels/spi/SelectorProvider)object.

<br />

<br />

|                                          Returns                                          ||
|------------------------------------------------------------------------|-------------------|
| [Pipe](https://developer.android.com/reference/java/nio/channels/Pipe) | A new pipe <br /> |

|                                               Throws                                               ||
|----------------------------------------------------------------------------|------------------------|
| [IOException](https://developer.android.com/reference/java/io/IOException) | If an I/O error occurs |

### sink

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract Pipe.SinkChannel sink ()
```

Returns this pipe's sink channel.

<br />

|                                                             Returns                                                             ||
|------------------------------------------------------------------------------------------------|---------------------------------|
| [Pipe.SinkChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SinkChannel) | This pipe's sink channel <br /> |

### source

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract Pipe.SourceChannel source ()
```

Returns this pipe's source channel.

<br />

|                                                                Returns                                                                ||
|----------------------------------------------------------------------------------------------------|-----------------------------------|
| [Pipe.SourceChannel](https://developer.android.com/reference/java/nio/channels/Pipe.SourceChannel) | This pipe's source channel <br /> |