com.github.robtimus.io.stream

Class BinaryPipe

java.lang.Object

com.github.robtimus.io.stream.BinaryPipe

public final class BinaryPipe
extends Object

An in-memory pipe. It can be used to connect code expecting an input stream with code expecting an output stream.

This is a port of Go's io.Pipe. Like io.Pipe, each write to a PipedOutputStream blocks until all of its data has been consumed, either through reads or skips. Data is copied directly from the output stream to the input stream without any internal buffering.

Because reads and writes both block, writing to and reading from the pipe should not be done from the same thread. Attempting to do so will introduce deadlocks.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
BinaryPipe() Creates a new binary pipe.

Method Summary

Modifier and Type	Method and Description
boolean	closed() Returns whether or not the pipe is closed.
PipeInputStream	input() Returns the pipe's input stream.
PipeOutputStream	output() Returns the pipe's output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryPipe

public BinaryPipe()

Creates a new binary pipe.

Method Detail

input

public PipeInputStream input()

Returns the pipe's input stream.

Returns:

The pipe's input stream.

output

public PipeOutputStream output()

Returns the pipe's output stream.

Returns:

The pipe's output stream.

closed

public boolean closed()

Returns whether or not the pipe is closed. The pipe can be closed by either closing the input or the output.

Returns:

true if the pipe is closed, or false otherwise.