ThrottledOutputStream (Data Pipeline JavaDoc)

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.northconcepts.datapipeline.meter.MeteredOutputStream

com.northconcepts.datapipeline.throttle.ThrottledOutputStream

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

public class ThrottledOutputStream extends MeteredOutputStream implements Throttled

A MeteredOutputStream that pauses before writes 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.FilterOutputStream
out
Constructor Summary

Constructors

Constructor

Description

ThrottledOutputStream(OutputStream out, int unitsPerSecond)

Creates a stream that limits writes to out to an average of unitsPerSecond bytes per second.
Method Summary

Modifier and Type

Method

Description

Throttle

getThrottle()

void

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

void

write(int b)

Methods inherited from class com.northconcepts.datapipeline.meter.MeteredOutputStream
close, getMeter

Methods inherited from class java.io.FilterOutputStream
flush, write

Methods inherited from class java.io.OutputStream
nullOutputStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ThrottledOutputStream
  
  public ThrottledOutputStream(OutputStream out, int unitsPerSecond)
  
  Creates a stream that limits writes to out to an average of unitsPerSecond bytes per second.
Method Details
- getThrottle
  
  public Throttle getThrottle()
  
  Specified by:
  
  getThrottle in interface Throttled
- write
  
  public void write(byte[] b, int off, int len) throws IOException
  
  Overrides:
  
  write in class MeteredOutputStream
  
  Throws:
  
  IOException
- write
  
  public void write(int b) throws IOException
  
  Overrides:
  
  write in class MeteredOutputStream
  
  Throws:
  
  IOException