org.apache.gobblin.util.io

Class ThrottledInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.gobblin.util.io.ThrottledInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class ThrottledInputStream
extends FilterInputStream

A throttled InputStream.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ThrottledInputStream(InputStream in, Limiter limiter, MeteredInputStream meter) Builds a ThrottledInputStream.

Method Summary

Modifier and Type	Method and Description
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottledInputStream

public ThrottledInputStream(InputStream in,
                            Limiter limiter,
                            MeteredInputStream meter)

Builds a ThrottledInputStream. It is recommended to use a StreamThrottler for creation of ThrottledInputStreams.

Parameters:

in - InputStream to throttle.

limiter - Limiter to use for throttling.

meter - MeteredInputStream used to measure the InputStream. Note the MeteredInputStream MUST be in the FilterInputStream chain of FilterInputStream.in.

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException