Package org.eclipse.ecf.provider.filetransfer.util

Class TimeoutInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.eclipse.ecf.provider.filetransfer.util.TimeoutInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TimeoutInputStream
extends FilterInputStream

Wraps an input stream that blocks indefinitely to simulate timeouts on read(), skip(), and close(). The resulting input stream is buffered and supports retrying operations that failed due to an InterruptedIOException. Supports resuming partially completed operations after an InterruptedIOException REGARDLESS of whether the underlying stream does unless the underlying stream itself generates InterruptedIOExceptions in which case it must also support resuming. Check the bytesTransferred field to determine how much of the operation completed; conversely, at what point to resume.

Since:

3.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
TimeoutInputStream(InputStream in, int bufferSize, long readTimeout, long closeTimeout)	Creates a timeout wrapper for an input stream.
TimeoutInputStream(InputStream in, int bufferSize, long readTimeout, long closeTimeout, boolean growWhenFull)

Method Summary

Modifier and Type	Method	Description
int	available()	Returns the number of unread bytes in the buffer.
void	close()	Wraps the underlying stream's method.
boolean	markSupported()	Mark is not supported by the wrapper even if the underlying stream does, returns false.
int	read()	Reads a byte from the stream.
int	read(byte[] buffer, int off, int len)	Reads multiple bytes from the stream.
long	skip(long count)	Skips multiple bytes in the stream.

Methods inherited from class java.io.FilterInputStream

mark, read, reset

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

TimeoutInputStream

public TimeoutInputStream(InputStream in,
 int bufferSize,
 long readTimeout,
 long closeTimeout)

Creates a timeout wrapper for an input stream.

Parameters:

in - the underlying input stream

bufferSize - the buffer size in bytes; should be large enough to mitigate Thread synchronization and context switching overhead

readTimeout - the number of milliseconds to block for a read() or skip() before throwing an InterruptedIOException; 0 blocks indefinitely

closeTimeout - the number of milliseconds to block for a close() before throwing an InterruptedIOException; 0 blocks indefinitely, -1 closes the stream in the background

TimeoutInputStream

public TimeoutInputStream(InputStream in,
 int bufferSize,
 long readTimeout,
 long closeTimeout,
 boolean growWhenFull)

Method Details

close

public void close()
           throws IOException

Wraps the underlying stream's method. It may be important to wait for a stream to actually be closed because it holds an implicit lock on a system resoure (such as a file) while it is open. Closing a stream may take time if the underlying stream is still servicing a previous request.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

InterruptedIOException - if the timeout expired

IOException - if an i/o error occurs

available

public int available()
              throws IOException

Returns the number of unread bytes in the buffer.

Overrides:

available in class FilterInputStream

Throws:

IOException - if an i/o error occurs

read

public int read()
         throws IOException

Reads a byte from the stream.

Overrides:

read in class FilterInputStream

Throws:

InterruptedIOException - if the timeout expired and no data was received, bytesTransferred will be zero

IOException - if an i/o error occurs

read

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

Reads multiple bytes from the stream.

Overrides:

read in class FilterInputStream

Throws:

InterruptedIOException - if the timeout expired and no data was received, bytesTransferred will be zero

IOException - if an i/o error occurs

skip

public long skip(long count)
          throws IOException

Skips multiple bytes in the stream.

Overrides:

skip in class FilterInputStream

Throws:

InterruptedIOException - if the timeout expired before all of the bytes specified have been skipped, bytesTransferred may be non-zero

IOException - if an i/o error occurs

markSupported

public boolean markSupported()

Mark is not supported by the wrapper even if the underlying stream does, returns false.

Overrides:

markSupported in class FilterInputStream