teetime.framework.pipe

Class BoundedSynchedPipe<T>

java.lang.Object

teetime.framework.AbstractPipe<T>

teetime.framework.pipe.AbstractSynchedPipe<T>

teetime.framework.pipe.BoundedSynchedPipe<T>

Type Parameters:

T - the type of the elements which this pipe should transfer.

All Implemented Interfaces:

IMonitorablePipe, IPipe<T>

public class BoundedSynchedPipe<T>
extends AbstractSynchedPipe<T>
implements IMonitorablePipe

Author:

Christian Wulf

Field Summary

Fields inherited from class teetime.framework.AbstractPipe

cachedTargetStage

Constructor Summary

Constructors

Constructor and Description
BoundedSynchedPipe(OutputPort<? extends T> sourcePort, InputPort<T> targetPort, int capacity)

Method Summary

Modifier and Type	Method and Description
void	add(Object element) Adds an element to the pipe.
boolean	addNonBlocking(Object element) Adds an element to the pipe.
int	capacity()
long	getNumPullsSinceAppStart()
long	getNumPushesSinceAppStart()
int	getNumWaits()
long	getPullThroughput()
long	getPushThroughput()
boolean	isEmpty() Checks whether the pipe is empty or not.
Object	removeLast() Retrieves and removes the last element from the pipe.
int	size()

Methods inherited from class teetime.framework.pipe.AbstractSynchedPipe

close, getSignal, isClosed, reportNewElement, sendSignal, waitForStartSignal

Methods inherited from class teetime.framework.AbstractPipe

getCachedTargetStage, getScheduler, getSourcePort, getTargetPort, hasMore, setScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedSynchedPipe

public BoundedSynchedPipe(OutputPort<? extends T> sourcePort,
                          InputPort<T> targetPort,
                          int capacity)

Method Detail

add

public void add(Object element)

Description copied from interface: IPipe

Adds an element to the pipe. This method does not return anything because it should guarantee element delivery (as opposed to IPipe.addNonBlocking(Object)). If it cannot guarantee element delivery in some special situation, it then must throw an exception.

Specified by:

add in interface IPipe<T>

Parameters:

element - to be added

addNonBlocking

public boolean addNonBlocking(Object element)

Description copied from interface: IPipe

Adds an element to the pipe.

Specified by:

addNonBlocking in interface IPipe<T>

Parameters:

element - Element which will be added

Returns:

true if the element could be added, false otherwise

removeLast

public Object removeLast()

Description copied from interface: IPipe

Retrieves and removes the last element from the pipe.

Specified by:

removeLast in interface IPipe<T>

Returns:

the last element from the pipe, or null if the pipe is currently empty.

isEmpty

public boolean isEmpty()

Description copied from interface: IPipe

Checks whether the pipe is empty or not.

Specified by:

isEmpty in interface IPipe<T>

Returns:

true if the pipe is empty, false otherwise.

size

public int size()

Specified by:

size in interface IMonitorablePipe

Specified by:

size in interface IPipe<T>

Returns:

the current number of elements held by this pipe instance

getNumWaits

public int getNumWaits()

Specified by:

getNumWaits in interface IMonitorablePipe

Returns:

the number of pauses of the pushing stage

getPushThroughput

public long getPushThroughput()

Specified by:

getPushThroughput in interface IMonitorablePipe

Returns:

the number of pushes to this queue since last method call

getPullThroughput

public long getPullThroughput()

Specified by:

getPullThroughput in interface IMonitorablePipe

Returns:

the number of pulls to this queue since last method call

getNumPushesSinceAppStart

public long getNumPushesSinceAppStart()

Specified by:

getNumPushesSinceAppStart in interface IMonitorablePipe

Returns:

the number of pushes to this queue since application start

getNumPullsSinceAppStart

public long getNumPullsSinceAppStart()

Specified by:

getNumPullsSinceAppStart in interface IMonitorablePipe

Returns:

the number of pulls from this queue since application start

capacity

public int capacity()

Specified by:

capacity in interface IMonitorablePipe

Specified by:

capacity in interface IPipe<T>

Returns:

the maximum number of elements possible to hold by this pipe instance