PipedOutputStream

public class PipedOutputStream extends OutputStream

Places information on a communications pipe. When two threads want to pass data back and forth, one creates a piped output stream and the other one creates a piped input stream.

See Also

• PipedInputStream

Public Constructor Summary

	PipedOutputStream() Constructs a new unconnected PipedOutputStream.
	PipedOutputStream(PipedInputStream target) Constructs a new PipedOutputStream connected to the PipedInputStream target.

Public Method Summary

void	close() Closes this stream.
void	connect(PipedInputStream stream) Connects this stream to a PipedInputStream.
void	flush() Notifies the readers of this PipedInputStream that bytes can be read.
void	write(byte[] buffer, int offset, int count) Writes count bytes from the byte array buffer starting at offset to this stream.
void	write(int oneByte) Writes a single byte to this stream.

Inherited Method Summary

From class java.io.OutputStream

void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
abstract void	write(int b) Writes the specified byte to this output stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Public Constructors

public PipedOutputStream ()

Constructs a new unconnected PipedOutputStream. The resulting stream must be connected to a PipedInputStream before data can be written to it.

public PipedOutputStream (PipedInputStream target)

Constructs a new PipedOutputStream connected to the PipedInputStream target. Any data written to this stream can be read from the target stream.

Parameters

target	the piped input stream to connect to.

Throws

IOException	if this stream or target are already connected.

Public Methods

public void close ()

Closes this stream. If this stream is connected to an input stream, the input stream is closed and the pipe is disconnected.

Throws

IOException	if an error occurs while closing this stream.

public void connect (PipedInputStream stream)

Connects this stream to a PipedInputStream. Any data written to this output stream becomes readable in the input stream.

Parameters

stream	the piped input stream to connect to.

Throws

IOException	if either stream is already connected.

public void flush ()

Notifies the readers of this PipedInputStream that bytes can be read. This method does nothing if this stream is not connected.

Throws

IOException	if an I/O error occurs while flushing this stream.

public void write (byte[] buffer, int offset, int count)

Writes count bytes from the byte array buffer starting at offset to this stream. The written data can then be read from the connected input stream.

Separate threads should be used to write to a PipedOutputStream and to read from the connected PipedInputStream. If the same thread is used, a deadlock may occur.

Parameters

buffer	the buffer to write.
offset	the index of the first byte in buffer to write.
count	the number of bytes from buffer to write to this stream.

Throws

IndexOutOfBoundsException	if offset < 0 or count < 0, or if offset + count is bigger than the length of buffer.
InterruptedIOException	if the pipe is full and the current thread is interrupted waiting for space to write data. This case is not currently handled correctly.
IOException	if this stream is not connected, if the target stream is closed or if the thread reading from the target stream is no longer alive. This case is currently not handled correctly.

public void write (int oneByte)

Writes a single byte to this stream. Only the least significant byte of the integer oneByte is written. The written byte can then be read from the connected input stream.

Separate threads should be used to write to a PipedOutputStream and to read from the connected PipedInputStream. If the same thread is used, a deadlock may occur.

Parameters

oneByte	the byte to write.

Throws

InterruptedIOException	if the pipe is full and the current thread is interrupted waiting for space to write data. This case is not currently handled correctly.
IOException	if this stream is not connected, if the target stream is closed or if the thread reading from the target stream is no longer alive. This case is currently not handled correctly.