Class ThrottledInputStream

java.lang.Object

java.io.InputStream

ecmwf.common.technical.ThrottledInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ThrottledInputStream
extends InputStream

The Class ThrottledInputStream.

Constructor Summary

Constructors

Constructor	Description
ThrottledInputStream(InputStream inputStream)	Instantiates a new throttled input stream.
ThrottledInputStream(InputStream inputStream, long maxBytesPerSec)	Instantiates a new throttled input stream.

Method Summary

Modifier and Type	Method	Description
void	close()	Close.
long	getBytesPerSec()	Return the number of bytes read per second.
long	getTotalBytesRead()	Gets the total bytes read.
long	getTotalSleepTime()	Gets the total sleep time.
int	read()	Read.
int	read(byte[] b)	Read.
int	read(byte[] b, int off, int len)	Read.
String	toString()	To string.

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ThrottledInputStream

public ThrottledInputStream(InputStream inputStream)

Instantiates a new throttled input stream.

Parameters:

inputStream - the input stream

ThrottledInputStream

public ThrottledInputStream(InputStream inputStream,
 long maxBytesPerSec)

Instantiates a new throttled input stream.

Parameters:

inputStream - the input stream

maxBytesPerSec - the max bytes per sec

Method Details

close

public void close()
           throws IOException

Close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Read.

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Read.

Overrides:

read in class InputStream

Throws:

IOException

read

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

Read.

Overrides:

read in class InputStream

Throws:

IOException

getTotalBytesRead

public long getTotalBytesRead()

Gets the total bytes read.

Returns:

the total bytes read

getBytesPerSec

public long getBytesPerSec()

Return the number of bytes read per second.

Returns:

the bytes per sec

getTotalSleepTime

public long getTotalSleepTime()

Gets the total sleep time.

Returns:

the total sleep time

toString

public String toString()

To string.

Overrides:

toString in class Object