at.borkowski.spicej.shapers

Interface RateShaper

All Known Implementing Classes:

RateLimitInputStream, RateLimitOutputStream

public interface RateShaper

An interface for byte rate shapers.

Method Summary

Modifier and Type	Method and Description
int	getByteRate() Returns the bytes per tick (after prescaling) for this rate shaper.
int	getPrescale() Returns the current prescale value (ie.
void	setByteRate(int byteRate) Sets a new byte rate per tick (after prescaling) for this rate shaper.
void	setPrescale(int prescale) Sets a new prescale value (ie.

Method Detail

setByteRate

void setByteRate(int byteRate)

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

Parameters:

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

getByteRate

int getByteRate()

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

Returns:

the current byte rate

getPrescale

int getPrescale()

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

Returns:

the current prescale value

setPrescale

void setPrescale(int prescale)

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

Parameters:

prescale - the new prescale