Added in API level 1

Summary: Ctors | Methods | Inherited Methods

PipedOutputStream

public class PipedOutputStream
extends OutputStream

java.lang.Object
↳	java.io.OutputStream
	↳	java.io.PipedOutputStream

A piped output stream can be connected to a piped input stream to create a communications pipe. The piped output stream is the sending end of the pipe. Typically, data is written to a PipedOutputStream object by one thread and data is read from the connected PipedInputStream by some other thread. Attempting to use both objects from a single thread is not recommended as it may deadlock the thread. The pipe is said to be broken if a thread that was reading data bytes from the connected piped input stream is no longer alive.

See also:

PipedInputStream

Summary

Public constructors
`PipedOutputStream()` Creates a piped output stream that is not yet connected to a piped input stream.
`PipedOutputStream(PipedInputStream snk)` Creates a piped output stream connected to the specified piped input stream.

Public methods
`void`	`close()` Closes this piped output stream and releases any system resources associated with this stream.
`void`	`connect(PipedInputStream snk)` Connects this piped output stream to a receiver.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this piped output stream.
`void`	`write(int b)` Writes the specified `byte` to the piped output stream.

Inherited methods

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.
`static OutputStream`	`nullOutputStream()` Returns a new `OutputStream` which discards all bytes.
`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)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

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

From interface


        
          java.io.Flushable


      flush()

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

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public constructors

PipedOutputStream

Added in API level 1

public PipedOutputStream ()

Creates a piped output stream that is not yet connected to a piped input stream. It must be connected to a piped input stream, either by the receiver or the sender, before being used.

See also:

PipedOutputStream

Added in API level 1

public PipedOutputStream (PipedInputStream snk)

Creates a piped output stream connected to the specified piped input stream. Data bytes written to this stream will then be available as input from snk.

Parameters
`snk`	`PipedInputStream`: The piped input stream to connect to.

Throws
`IOException`	if an I/O error occurs.

Public methods

close

Added in API level 1

public void close ()

Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing bytes.

Throws
`IOException`	if an I/O error occurs.

connect

Added in API level 1

public void connect (PipedInputStream snk)

Connects this piped output stream to a receiver. If this object is already connected to some other piped input stream, an IOException is thrown.

If snk is an unconnected piped input stream and src is an unconnected piped output stream, they may be connected by either the call:

 src.connect(snk)

or the call:

 snk.connect(src)

The two calls have the same effect.

Parameters
`snk`	`PipedInputStream`: the piped input stream to connect to.

Throws
`IOException`	if an I/O error occurs.

flush

Added in API level 1

public void flush ()

Flushes this output stream and forces any buffered output bytes to be written out. This will notify any readers that bytes are waiting in the pipe.

Throws
`IOException`	if an I/O error occurs.

write

Added in API level 1

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

Writes len bytes from the specified byte array starting at offset off to this piped output stream. This method blocks until all the bytes are written to the output stream.

Parameters
`b`	`byte`: the data.
`off`	`int`: the start offset in the data.
`len`	`int`: the number of bytes to write.

Throws
`IOException`	if the pipe is broken, `unconnected`, closed, or if an I/O error occurs.

write

Added in API level 1

public void write (int b)

Writes the specified byte to the piped output stream.

Implements the write method of OutputStream.

Parameters
`b`	`int`: the `byte` to be written.

Throws
`IOException`	if the pipe is broken, `unconnected`, closed, or if an I/O error occurs.