Package org.apache.commons.io.input

Class ThrottledInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.CountingInputStream

org.apache.commons.io.input.ThrottledInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class ThrottledInputStream
extends CountingInputStream

Provides bandwidth throttling on a specified InputStream. It is implemented as a wrapper on top of another InputStream instance. The throttling works by examining the number of bytes read from the underlying InputStream from the beginning, and sleep()ing for a time interval if the byte-transfer is found exceed the specified tolerable maximum. (Thus, while the read-rate might exceed the maximum for a short interval, the average tends towards the specified maximum, overall.)

To build an instance, see ThrottledInputStream.Builder

Inspired by Apache HBase's class of the same name.

Since:

2.16.0

See Also:

ThrottledInputStream.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThrottledInputStream.Builder	Builds a new ThrottledInputStream.

Method Summary

Modifier and Type	Method	Description
static ThrottledInputStream.Builder	builder()	Constructs a new ThrottledInputStream.Builder.
java.lang.String	toString()

Methods inherited from class org.apache.commons.io.input.CountingInputStream

getByteCount, getCount, resetByteCount, resetCount, skip

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, close, mark, markSupported, read, read, read, reset, unwrap

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ThrottledInputStream.Builder builder()

Constructs a new ThrottledInputStream.Builder.

Returns:

a new ThrottledInputStream.Builder.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object