Pipe
abstract class Pipe
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| abstract |
A channel representing the writable end of a |
| abstract |
A channel representing the readable end of a |
| Protected constructors | |
|---|---|
Pipe()Initializes a new instance of this class. |
|
| Public methods | |
|---|---|
| open 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. |
Protected constructors
Public methods
open
open static fun open(): Pipe!
Opens a pipe.
The new pipe is created by invoking the openPipe method of the system-wide default java.nio.channels.spi.SelectorProvider object.
| Return | |
|---|---|
Pipe! |
A new pipe |
| Exceptions | |
|---|---|
java.io.IOException |
If an I/O error occurs |
sink
abstract fun sink(): Pipe.SinkChannel!
Returns this pipe's sink channel.
| Return | |
|---|---|
Pipe.SinkChannel! |
This pipe's sink channel |
source
abstract fun source(): Pipe.SourceChannel!
Returns this pipe's source channel.
| Return | |
|---|---|
Pipe.SourceChannel! |
This pipe's source channel |