ThrottledInputStream (Data Pipeline JavaDoc)

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.northconcepts.datapipeline.meter.MeteredInputStream

com.northconcepts.datapipeline.throttle.ThrottledInputStream

All Implemented Interfaces:: Metered, Throttled, Closeable, AutoCloseable

public class ThrottledInputStream extends MeteredInputStream implements Throttled

A MeteredInputStream that pauses after reads when needed to keep its average rate at or below a set number of bytes per second.

Field Summary

Fields inherited from class java.io.FilterInputStream
in
Constructor Summary

Constructors

Constructor

Description

ThrottledInputStream(InputStream in, int unitsPerSecond)

Creates a stream that limits reads from in to an average of unitsPerSecond bytes per second.
Method Summary

Modifier and Type

Method

Description

Throttle

getThrottle()

int

read()

int

read(byte[] b, int off, int len)

Methods inherited from class com.northconcepts.datapipeline.meter.MeteredInputStream
close, getMeter, reset, skip

Methods inherited from class java.io.FilterInputStream
available, mark, markSupported, read

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
- ThrottledInputStream
  
  public ThrottledInputStream(InputStream in, int unitsPerSecond)
  
  Creates a stream that limits reads from in to an average of unitsPerSecond bytes per second.
Method Details
- getThrottle
  
  public Throttle getThrottle()
  
  Specified by:
  
  getThrottle in interface Throttled
- read
  
  public int read() throws IOException
  
  Overrides:
  
  read in class MeteredInputStream
  
  Throws:
  
  IOException
- read
  
  public int read(byte[] b, int off, int len) throws IOException
  
  Overrides:
  
  read in class MeteredInputStream
  
  Throws:
  
  IOException