Package hudson.remoting

Class FastPipedInputStream

java.lang.Object

java.io.InputStream

hudson.remoting.FastPipedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class FastPipedInputStream
extends InputStream

This class is equivalent to java.io.PipedInputStream. In the interface it only adds a constructor which allows for specifying the buffer size. Its implementation, however, is much simpler and a lot more efficient than its equivalent. It doesn't rely on polling. Instead it uses proper synchronization with its counterpart FastPipedOutputStream.

Author:

WD

See Also:

4404700, FastPipedOutputStream

Constructor Summary

Constructors

Constructor	Description
FastPipedInputStream()	Creates an unconnected PipedInputStream with a default buffer size.
FastPipedInputStream(FastPipedOutputStream source)	Creates a PipedInputStream with a default buffer size and connects it to source.
FastPipedInputStream(FastPipedOutputStream source, int bufferSize)	Creates a PipedInputStream with buffer size bufferSize and connects it to source.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	connect(FastPipedOutputStream source)
protected void	finalize()
void	mark(int readLimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

FastPipedInputStream

public FastPipedInputStream()

Creates an unconnected PipedInputStream with a default buffer size.

FastPipedInputStream

public FastPipedInputStream(FastPipedOutputStream source)
                     throws IOException

Creates a PipedInputStream with a default buffer size and connects it to source.

Throws:

IOException - It was already connected.

FastPipedInputStream

public FastPipedInputStream(FastPipedOutputStream source,
                            int bufferSize)
                     throws IOException

Creates a PipedInputStream with buffer size bufferSize and connects it to source.

Throws:

IOException - It was already connected.

Method Detail

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException - The pipe is not connected.

connect

public void connect(FastPipedOutputStream source)
             throws IOException

Throws:

IOException - The pipe is already connected.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

mark

public void mark(int readLimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(@NonNull
                byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(@NonNull
                byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException - The pipe is not connected.