at.borkowski.spicej.streams

Class RateLimitOutputStream

java.lang.Object

java.io.OutputStream

at.borkowski.spicej.streams.RateLimitOutputStream

All Implemented Interfaces:

RateShaper, Closeable, Flushable, AutoCloseable

public class RateLimitOutputStream
extends OutputStream
implements RateShaper

Provides an OutputStream with a limited rate of bytes. For a description of blocking mode, see RateLimitInputStream.

Constructor Summary

Constructors

Constructor and Description
RateLimitOutputStream(OutputStream real, TickSource tickSource, int byteRate, int prescale) Constructs a byte-rate-limited OutputStream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
OutputStream	getBaseStream() Returns the underlying OutputStream.
int	getByteRate() Returns the bytes per tick (after prescaling) for this rate shaper.
int	getPrescale() Returns the current prescale value (ie.
TickSource	getTickSource() Returns the TickSource this stream uses.
void	setByteRate(int bytesPerTick) Sets a new byte rate per tick (after prescaling) for this rate shaper.
void	setNonBlocking(boolean nonBlocking) Sets the non-blocking flag.
void	setPrescale(int prescale) Sets a new prescale value (ie.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitOutputStream

public RateLimitOutputStream(OutputStream real,
                             TickSource tickSource,
                             int byteRate,
                             int prescale)

Constructs a byte-rate-limited OutputStream. See RateLimitInputStream for a description of the rate parameters (byteRate and prescale).

Parameters:

real - The raw OutputStream to send to

tickSource - The tick source to use

byteRate - The rate in bytes per tick (before prescaler) to use

prescale - The prescaler to use (see RateLimitInputStream)

Method Detail

setByteRate

public void setByteRate(int bytesPerTick)

Description copied from interface: RateShaper

Sets a new byte rate per tick (after prescaling) for this rate shaper.

Specified by:

setByteRate in interface RateShaper

Parameters:

bytesPerTick - the new byte rate per tick (after prescaling)

getByteRate

public int getByteRate()

Description copied from interface: RateShaper

Returns the bytes per tick (after prescaling) for this rate shaper.

Specified by:

getByteRate in interface RateShaper

Returns:

the current byte rate

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

setNonBlocking

public void setNonBlocking(boolean nonBlocking)

Sets the non-blocking flag.

Parameters:

nonBlocking - whether the stream should be in non-blocking mode (see RateLimitInputStream).

getPrescale

public int getPrescale()

Description copied from interface: RateShaper

Returns the current prescale value (ie. one of how many ticks is actually counting towards the things per tick notion).

Specified by:

getPrescale in interface RateShaper

Returns:

the current prescale value

setPrescale

public void setPrescale(int prescale)

Description copied from interface: RateShaper

Sets a new prescale value (ie. one of how many ticks is actually counting towards the things per tick notion).

Specified by:

setPrescale in interface RateShaper

Parameters:

prescale - the new prescale

getBaseStream

public OutputStream getBaseStream()

Returns the underlying OutputStream.

Returns:

the underlying stream

getTickSource

public TickSource getTickSource()

Returns the TickSource this stream uses.

Returns:

the used tick source