org.spf4j.io

Class PipedOutputStream

java.lang.Object

java.io.OutputStream

org.spf4j.io.PipedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@ThreadSafe
 @CleanupObligation
public final class PipedOutputStream
extends OutputStream

Equivalent to Java piped input/output stream. This implementation supports timeouts, timeout are specified by setting in the ExecutionContext Implementation supports multiple readers and writers. Data is available to readers only after it is flushed. (happens automatically when buffer is full) This implementation should be slightly faster than the JDK implementation.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PipedOutputStream.PipedInputStream

Constructor Summary

Constructors

Constructor and Description
PipedOutputStream()
PipedOutputStream(int bufferSize)
PipedOutputStream(int bufferSize, long globalDeadlineMillis) Deprecated. use constructor that takes globalDeadlineNanos.
PipedOutputStream(int bufferSize, SizedRecyclingSupplier<byte[]> bufferProvider)
PipedOutputStream(int bufferSize, SizedRecyclingSupplier<byte[]> bufferProvider, Long globalDeadlineMillis) Deprecated. use constructor that takes globalDeadlineNanos.
PipedOutputStream(long globalDeadlineNanos, int bufferSize) Create a PipedOutputStream with a global deadline relative to System.nanoTime().
PipedOutputStream(Long globalDeadlineNanos, int bufferSize, SizedRecyclingSupplier<byte[]> bufferProvider) Create a PipedOutputStream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(Exception ex) Close this piped output stream, and provide a exception reason.
void	flush()
InputStream	getInputStream()
long	getNanoDeadline()
byte[]	getUnreadBytesFromBuffer()
String	toString()
void	write(byte[] b, int off, int len)
void	write(int b)
void	writeUntil(byte[] b, int off, int len, long deadlineNanos)
void	writeUntil(int b, long deadlineNanos)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

PipedOutputStream

public PipedOutputStream()

PipedOutputStream

public PipedOutputStream(int bufferSize)

PipedOutputStream

@Deprecated
public PipedOutputStream(int bufferSize,
                                     long globalDeadlineMillis)

Deprecated. use constructor that takes globalDeadlineNanos.

PipedOutputStream

public PipedOutputStream(long globalDeadlineNanos,
                         int bufferSize)

Create a PipedOutputStream with a global deadline relative to System.nanoTime().

Parameters:

globalDeadlineNanos - deadline relative to System.nanoTime().

bufferSize - the buffer size.

PipedOutputStream

public PipedOutputStream(int bufferSize,
                         SizedRecyclingSupplier<byte[]> bufferProvider)

PipedOutputStream

@Deprecated
public PipedOutputStream(int bufferSize,
                                     SizedRecyclingSupplier<byte[]> bufferProvider,
                                     @Nullable
                                     Long globalDeadlineMillis)

Deprecated. use constructor that takes globalDeadlineNanos.

PipedOutputStream

public PipedOutputStream(@Nullable
                         Long globalDeadlineNanos,
                         int bufferSize,
                         SizedRecyclingSupplier<byte[]> bufferProvider)

Create a PipedOutputStream.

Parameters:

globalDeadlineNanos - the deadline relative to System.nanoTime().

bufferSize - the buffer size in bytes.

bufferProvider - a buffer provider. (to allow more efficient recycling)

Method Detail

write

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

Overrides:

write in class OutputStream

Throws:

IOException

getNanoDeadline

public long getNanoDeadline()

writeUntil

public void writeUntil(byte[] b,
                       int off,
                       int len,
                       long deadlineNanos)
                throws IOException

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

writeUntil

public void writeUntil(int b,
                       long deadlineNanos)
                throws IOException

Throws:

IOException

flush

public void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

close

@DischargesObligation
public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

close

@DischargesObligation
public void close(Exception ex)

Close this piped output stream, and provide a exception reason. Designed to propagate exception details from the consumer to the producer. A consumer that reads data from a InputStream connected to this PipedOutpuStream, can close this pipe, and provide a exception. THis exception will be used as cause for any exceptions thrown by subsequent attempted write operations.

Parameters:

ex - the exception to use as root cause.

getInputStream

public InputStream getInputStream()

getUnreadBytesFromBuffer

public byte[] getUnreadBytesFromBuffer()

toString

public String toString()

Overrides:

toString in class Object