org.mule.service.http.impl.util

Class TimedPipedInputStream

java.lang.Object

java.io.InputStream

org.mule.service.http.impl.util.TimedPipedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TimedPipedInputStream
extends InputStream

Input stream which is blocking only during a specified timeout. It requires to be connected with a TimedPipedOutputStream.

Since:

1.6.0 and 1.5.11.

Constructor Summary

Constructors

Constructor and Description
TimedPipedInputStream(int bufferSize, long timeout, TimeUnit timeUnit, TimedPipedOutputStream origin)

Method Summary

Modifier and Type	Method and Description
int	available() Gets the number of bytes available to be read.
void	close()
int	read()
int	read(byte[] b) See InputStream, but it may return 0 if no byte has been read after the specified timeout.
int	read(byte[] b, int off, int len) See InputStream, but it may return 0 if no byte has been read after the specified timeout.

Methods inherited from class java.io.InputStream

mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedPipedInputStream

public TimedPipedInputStream(int bufferSize,
                             long timeout,
                             TimeUnit timeUnit,
                             TimedPipedOutputStream origin)

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

See InputStream, but it may return 0 if no byte has been read after the specified timeout.

Overrides:

read in class InputStream

Parameters:

b - Destination buffer.

Returns:

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

Throws:

IOException

read

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

See InputStream, but it may return 0 if no byte has been read after the specified timeout.

Overrides:

read in class InputStream

Parameters:

b - Destination buffer.

Returns:

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

Throws:

IOException

available

public int available()

Gets the number of bytes available to be read.

Overrides:

available in class InputStream

Returns:

The number of available bytes.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException