com.hypirion.io

Class Pipe

java.lang.Object

com.hypirion.io.Pipe

Direct Known Subclasses:

ClosingPipe

public class Pipe
extends java.lang.Object

A Pipe 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.

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
static int	DEFAULT_BUFFER_SIZE The default size of a pipe's buffer.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	join() Waits for this pipe to finish piping.
void	pause() Pauses this pipe.
void	pause(boolean block) Pauses this pipe.
void	start() Starts up this pipe.
void	stop() Stops this pipe.
void	stop(boolean block) Stops this pipe.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default size of a pipe's buffer.

Since:

com.hypirion.io 0.2.0

See Also:

Constant Field Values

Constructor Detail

Pipe

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

Creates a new 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.

Pipe

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

Creates a new 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.

Pipe

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

Creates a new 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.

Pipe

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

Creates a new 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.

Method Detail

join

public void join()
          throws java.lang.InterruptedException

Waits for this pipe to finish piping. This happens when this pipe is stopped and the last blocking read has finished.

Throws:

java.lang.InterruptedException - if this thread is interrupted while waiting.

See Also:

stop(), stop(boolean)

start

public void start()

Starts up this pipe. If this pipe has not yet been started or has been paused, this method will (re)start the pipe. When this pipe is stopped, this method will do nothing.

pause

public void pause()
           throws java.lang.InterruptedException

Pauses this pipe. Will block until the current blocking read by this pipe has finished, regardless of whether this pipe has been stopped or not. If this pipe has already been paused or stopped, and there is no blocking read waiting, will immediatly return.

Throws:

java.lang.InterruptedException - if this thread is interrupted while waiting.

See Also:

pause(boolean)

pause

public void pause(boolean block)
           throws java.lang.InterruptedException

Pauses this pipe. If block is true, will wait until the current blocking read by this pipe has finished. Will otherwise notify this pipe and return immediately.

Parameters:

block - whether to wait for the blocking read (if any) or not.

Throws:

java.lang.InterruptedException - if this thread is interrupted while waiting.

stop

public void stop()
          throws java.lang.InterruptedException

Stops this pipe. Will wait until the last blocking read has finished.

Throws:

java.lang.InterruptedException - if this thread is interrupted while waiting.

See Also:

stop(boolean)

stop

public void stop(boolean block)
          throws java.lang.InterruptedException

Stops this pipe. Will wait until the last blocking read has finished. If block is true, will wait until the current blocking read by this pipe has finished. Will otherwise notify this pipe and return immediately.

Parameters:

block - whether to wait for the blocking read (if any) or not.

Throws:

java.lang.InterruptedException - if this thread is interrupted while waiting.