at.borkowski.spicej

Class Streams

java.lang.Object

at.borkowski.spicej.Streams

public class Streams
extends Object

Provides helper functions for easy shaping of streams.

Method Summary

Modifier and Type	Method and Description
static DelayedInputStream	addDelay(InputStream base, TickSource tickSource, long delay, int bufferSize) Creates a delayed InputStream.
static RateLimitInputStream	limitRate(InputStream base, TickSource tickSource, int bytesPerTick, int prescale) Creates a byte-rate-limited InputStream.
static RateLimitOutputStream	limitRate(OutputStream base, TickSource tickSource, int bytesPerTick, int prescaler) Creates a byte-rate-limited OutputStream.

Methods inherited from class java.lang.Object

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

Method Detail

limitRate

public static RateLimitInputStream limitRate(InputStream base,
                                             TickSource tickSource,
                                             int bytesPerTick,
                                             int prescale)

Creates a byte-rate-limited InputStream. See RateLimitInputStream.RateLimitInputStream(InputStream, TickSource, int, int) for detailed information.

Parameters:

base - The raw (underlying) InputStream

tickSource - The source of ticks

bytesPerTick - (see RateLimitInputStream.RateLimitInputStream(InputStream, TickSource, int, int) )

prescale - (see RateLimitInputStream.RateLimitInputStream(InputStream, TickSource, int, int) )

Returns:

the resulting input stream

limitRate

public static RateLimitOutputStream limitRate(OutputStream base,
                                              TickSource tickSource,
                                              int bytesPerTick,
                                              int prescaler)

Creates a byte-rate-limited OutputStream. See RateLimitOutputStream.RateLimitOutputStream(OutputStream, TickSource, int, int) for detailed information.

Parameters:

base - The raw (underlying) OutputStream

tickSource - The source of ticks

bytesPerTick - (see RateLimitOutputStream.RateLimitOutputStream(OutputStream, TickSource, int, int) )

prescaler - (see RateLimitOutputStream.RateLimitOutputStream(OutputStream, TickSource, int, int) )

Returns:

the resulting output stream

addDelay

public static DelayedInputStream addDelay(InputStream base,
                                          TickSource tickSource,
                                          long delay,
                                          int bufferSize)

Creates a delayed InputStream. See DelayedInputStream.DelayedInputStream(TickSource, InputStream, long, int) for detailed information.

Parameters:

base - The raw (underlying) InputStream.

tickSource - The source of ticks

delay - The delay in ticks to add to the stream

bufferSize - The buffer size to use (see DelayedInputStream.DelayedInputStream(TickSource, InputStream, long, int) )

Returns:

the resulting input stream