Package org.greenrobot.essentials.io

Class PipelineOutputStream

java.lang.Object

java.io.OutputStream

org.greenrobot.essentials.io.PipelineOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class PipelineOutputStream
extends OutputStream

Replacement for Java's PipedOutputStream: all data written to this stream will get available in the integrated InputStream (see getInputStream()).

Note: Usually, you will have exactly two threads: one to write and one to read. If you use a single thread, avoid reading more bytes than previously written or writing more bytes than the internal buffer can handle.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	PipelineOutputStream.PipelineInputStream

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final CircularByteBuffer	buffer
(package private) boolean	closedIn
(package private) boolean	closedOut
private final PipelineOutputStream.PipelineInputStream	inputStream

Constructor Summary

Constructors

Constructor	Description
PipelineOutputStream()
PipelineOutputStream(int bufferCapacity)

Method Summary

Modifier and Type	Method	Description
private void	checkPipelineInput()
void	close()
InputStream	getInputStream()
(package private) void	notifyBuffer()
(package private) void	waitForBuffer()
void	write(byte[] data, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write

Methods inherited from class java.lang.Object

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

Field Details

inputStream

private final PipelineOutputStream.PipelineInputStream inputStream

buffer

final CircularByteBuffer buffer

closedOut

boolean closedOut

closedIn

boolean closedIn

Constructor Details

PipelineOutputStream

public PipelineOutputStream()

PipelineOutputStream

public PipelineOutputStream(int bufferCapacity)

Method Details

getInputStream

public InputStream getInputStream()

write

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

Overrides:

write in class OutputStream

Throws:

IOException

checkPipelineInput

private void checkPipelineInput()
                         throws IOException

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

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

waitForBuffer

void waitForBuffer()
            throws IOException

Throws:

IOException

notifyBuffer

void notifyBuffer()