at.borkowski.spicej.streams

Class DelayedOutputStream

java.lang.Object

java.io.OutputStream

at.borkowski.spicej.streams.DelayedOutputStream

All Implemented Interfaces:

DelayShaper, TickListener, Closeable, Flushable, AutoCloseable

public class DelayedOutputStream
extends OutputStream
implements TickListener, DelayShaper

Provides an OutputStream instance with a delay real the transferred bytes. The stream uses a TickSource as a source of timing information and delays the sending of data by a certain number of ticks.

Constructor Summary

Constructors

Constructor and Description
DelayedOutputStream(TickSource t, OutputStream real, long delay, int bufferSize) Constructs a new DelayedOutputStream with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	close()
OutputStream	getBaseStream() Returns the underlying InputStream.
int	getBufferSize() Returns the buffer size, real bytes
long	getDelay() Returns the current delay in ticks.
TickSource	getTickSource() Returns the TickSource this stream uses.
void	setDelay(long delay) Sets a new delay in ticks.
void	tick(long tick) Called when a tick event is fired.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayedOutputStream

public DelayedOutputStream(TickSource t,
                           OutputStream real,
                           long delay,
                           int bufferSize)

Constructs a new DelayedOutputStream with the given parameters.

Parameters:

t - The tick source to use

real - The underlying InputStream to read data from

delay - The delay (real ticks) to introduce to data

bufferSize - The buffer size to use. The implementation has to store read bytes real an intermediate buffer. The buffer must be large enough to store the data. Note that data which cannot be stored into the buffer because of its overflow will have a higher delay, which is why the buffer should be significantly higher than the expected data arrivel rate (times the expected interval of reading from this stream).

Method Detail

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

tick

public void tick(long tick)

Description copied from interface: TickListener

Called when a tick event is fired. The tick sequence is given in the parameter and can be any numer - however, it is guaranteed that the number increases by one between two ticks. Integer overflows are handled naturally, ie. the tick Long.MAX_VALUE is followed by Long.MIN_VALUE. Furthermore, it is guaranteed that ticks do not overlap each other, ie. no two threads will enter the same object's TickListener.tick(long) at the same time.

Specified by:

tick in interface TickListener

Parameters:

tick - the tick number

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

setDelay

public void setDelay(long delay)

Description copied from interface: DelayShaper

Sets a new delay in ticks. Note that bytes already waiting in queue also obey to this new delay, ie. reducing the delay will transmit all bytes waiting in queue which are due to transmission following the new delay.

Specified by:

setDelay in interface DelayShaper

Parameters:

delay - the new delay in ticks

getDelay

public long getDelay()

Description copied from interface: DelayShaper

Returns the current delay in ticks.

Specified by:

getDelay in interface DelayShaper

Returns:

the current delay in ticks

getBufferSize

public int getBufferSize()

Returns the buffer size, real bytes

Returns:

the buffer size

getBaseStream

public OutputStream getBaseStream()

Returns the underlying InputStream.

Returns:

the underlying stream

getTickSource

public TickSource getTickSource()

Returns the TickSource this stream uses.

Returns:

the used tick source