Package hudson.remoting

Class FastPipedOutputStream

java.lang.Object

java.io.OutputStream

hudson.remoting.FastPipedOutputStream

All Implemented Interfaces:

ErrorPropagatingOutputStream, Closeable, Flushable, AutoCloseable

public class FastPipedOutputStream
extends OutputStream
implements ErrorPropagatingOutputStream

This class is equivalent to java.io.PipedOutputStream. 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 FastPipedInputStream.

Author:

WD

See Also:

4404700, FastPipedOutputStream

Constructor Summary

Constructors

Constructor	Description
FastPipedOutputStream()	Creates an unconnected PipedOutputStream.
FastPipedOutputStream(FastPipedInputStream sink)	Creates a PipedOutputStream with a default buffer size and connects it to sink.
FastPipedOutputStream(FastPipedInputStream sink, int bufferSize)	Deprecated. as of 1.350 bufferSize parameter is ignored.

Method Summary

Modifier and Type	Method	Description
void	close()
void	connect(FastPipedInputStream sink)
void	error(Throwable e)	Closes the stream and causes the reading InputStream to report an error.
protected void	finalize()
void	flush()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

FastPipedOutputStream

public FastPipedOutputStream()

Creates an unconnected PipedOutputStream.

FastPipedOutputStream

public FastPipedOutputStream(FastPipedInputStream sink)
                      throws IOException

Creates a PipedOutputStream with a default buffer size and connects it to sink.

Throws:

IOException - It was already connected.

FastPipedOutputStream

@Deprecated
public FastPipedOutputStream(FastPipedInputStream sink,
                             int bufferSize)
                      throws IOException

Deprecated.

as of 1.350 bufferSize parameter is ignored.

Creates a PipedOutputStream with buffer size bufferSize and connects it to sink.

Throws:

IOException - It was already connected.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException - The pipe is not connected.

error

public void error(Throwable e)
           throws IOException

Description copied from interface: ErrorPropagatingOutputStream

Closes the stream and causes the reading InputStream to report an error.

This method is somewhat like OutputStream.close(), in that it signals the end of a stream. In addition to what the close method does, this method will cause the InputStream.read() method (or any other overloaded versions) to throw an IOException with the given throwable as the cause.

InputStream will report an error only after all the data that has written before is read. IOW, the error will not magically jump over the data that was written.

This is useful to propagate error over a pipe. If used over a channel with the remoting library that doesn't yet support this, or if the OutputStream isn't connecting to an InputStream, this method behaves exactly like OutputStream.close().

If OutputStream is already closed or error state is set, this method will be no-op.

Specified by:

error in interface ErrorPropagatingOutputStream

Parameters:

e - if null, this method behaves exactly like OutputStream.close()

Throws:

IOException

connect

public void connect(FastPipedInputStream sink)
             throws IOException

Throws:

IOException - The pipe is already connected.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(@NonNull
                  byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException - The pipe is not connected or a reader has closed it.