com.hypirion.io

Class ClosingPipe

java.lang.Object

com.hypirion.io.Pipe

com.hypirion.io.ClosingPipe

public class ClosingPipe
extends Pipe

A ClosingPipe is a link between an input stream and an output stream or a reader or writer: The pipe, once started, will asynchronously redirect all data received from the input source to the output source until it is paused, stopped or the input source is empty. When the input source has been closed, or the pipe has been stopped, a ClosingPipe will close the output source afterwards.

Common usage of pipes includes asynchronous zipping of data from two data sources, redirecting output and input to subprocesses and for loggers you want to just pipe from and input source.

Since:

com.hypirion.io 0.2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Thread	closer

Fields inherited from class com.hypirion.io.Pipe

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
ClosingPipe(java.io.InputStream in, java.io.OutputStream out) Creates a new closing pipe, which redirects data from the stream in to the stream out once started.
ClosingPipe(java.io.InputStream in, java.io.OutputStream out, int bufsize) Creates a new closing pipe with buffer size bufsize, which redirects data from the stream in to the stream out once started.
ClosingPipe(java.io.Reader in, java.io.Writer out) Creates a new closing pipe, which redirects data from the reader in to the writer out once started.
ClosingPipe(java.io.Reader in, java.io.Writer out, int bufsize) Creates a new closing pipe with buffer size bufsize, which redirects data from the reader in to the writer out once started.

Method Summary

Methods inherited from class com.hypirion.io.Pipe

join, pause, pause, start, stop, stop

Methods inherited from class java.lang.Object

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

Field Detail

closer

protected final java.lang.Thread closer

Constructor Detail

ClosingPipe

public ClosingPipe(java.io.InputStream in,
           java.io.OutputStream out)

Creates a new closing pipe, which redirects data from the stream in to the stream out once started.

Parameters:

in - the input stream to read from.

out - the output stream to write out to.

ClosingPipe

public ClosingPipe(java.io.InputStream in,
           java.io.OutputStream out,
           int bufsize)

Creates a new closing pipe with buffer size bufsize, which redirects data from the stream in to the stream out once started.

Parameters:

in - the input stream to read from.

out - the output stream to write out to.

bufsize - the buffer size of the pipe.

ClosingPipe

public ClosingPipe(java.io.Reader in,
           java.io.Writer out)

Creates a new closing pipe, which redirects data from the reader in to the writer out once started.

Parameters:

in - the reader to read from.

out - the writer to write out to.

ClosingPipe

public ClosingPipe(java.io.Reader in,
           java.io.Writer out,
           int bufsize)

Creates a new closing pipe with buffer size bufsize, which redirects data from the reader in to the writer out once started.

Parameters:

in - the reader to read from.

out - the writer to write out to.

bufsize - the buffer size of the pipe.