Package java.io

Previous

Java API

Index

Next

Class PipedInputStream

public  class  java.io.PipedInputStream
    extends  java.io.InputStream  
{
        // Constructors
    public PipedInputStream();	
    public PipedInputStream(PipedOutputStream  src);	

        // Methods
    public void close();	
    public void connect(PipedOutputStream  src);	
    public int read();	
    public int read(byte  b[], int  off, int  len);	
}

A piped input stream is the receiving end a communications pipe. Two threads can communicate by having one thread send data through a piped output stream and having the other thread read the data through a piped input stream.

Constructors

PipedInputStream

public PipedInputStream() 

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

PipedInputStream

public PipedInputStream(PipedOutputStream  src) 

throws IOException 

Creates a piped input stream connected to the specified piped output stream.

Parameter	Description
src	the stream to connect to.

Throw:

IOException

If an I/O error occurs.

Methods

close

public void close() 

throws IOException 

Closes this piped input stream and releases any system resources associated with the stream.

Throw:

IOException

If an I/O error occurs.

Overrides:

close in class InputStream .

connect

public void connect(PipedOutputStream  src) 

throws IOException 

Connects this piped input stream to a sender.

Parameter	Description
src	The piped output stream to connect to.

Throw:

IOException

If an I/O error occurs.

read

public int read() 

throws IOException 

Reads the next byte of data from this piped input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because this end of the stream has been reached, the value -1 is returned. This method blocks until either input data is available, the end of the stream is detected, or an exception is thrown.

Return Value:

Returns the next byte of data, or -1 if the end of the stream is reached.

Throw:

IOException

If the pipe is broken.

Overrides:

read in class InputStream .

read

public int read(byte  b[], int  off, int  len) 

throws IOException 

Reads up to len bytes of data from this piped input stream into an array of bytes. This method blocks until at least one byte of input is available.

Return Value:

Returns the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

Parameter	Description
b	the buffer into which the data is read
off	the start offset of the data
len	the maximum number of bytes read

Throw:

IOException

If an I/O error occurs.

Overrides:

read in class InputStream .