teetime.framework.pipe

Class AbstractSynchedPipe<T>

java.lang.Object

teetime.framework.AbstractPipe<T>

teetime.framework.pipe.AbstractSynchedPipe<T>

Type Parameters:

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

All Implemented Interfaces:

IPipe<T>

Direct Known Subclasses:

BoundedSynchedPipe, UnboundedSynchedPipe

public abstract class AbstractSynchedPipe<T>
extends AbstractPipe<T>

Author:

Christian Wulf

Field Summary

Fields inherited from class teetime.framework.AbstractPipe

cachedTargetStage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSynchedPipe(OutputPort<? extends T> sourcePort, InputPort<T> targetPort)

Method Summary

Modifier and Type	Method and Description
void	close() May only be invoked by the input port and the owning (target) stage.
ISignal	getSignal() Retrieves and removes the head of the signal queue
boolean	isClosed()
void	reportNewElement() Deprecated. since 3.0. Is removed without replacement.
void	sendSignal(ISignal signal) A stage can pass on a signal by executing this method.
void	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

Methods inherited from interface teetime.framework.pipe.IPipe

add, addNonBlocking, capacity, isEmpty, removeLast, size

Constructor Detail

AbstractSynchedPipe

protected AbstractSynchedPipe(OutputPort<? extends T> sourcePort,
                              InputPort<T> targetPort)

Method Detail

sendSignal

public void sendSignal(ISignal signal)

Description copied from interface: IPipe

A stage can pass on a signal by executing this method. The signal will be sent to the receiving stage.

Parameters:

signal - The signal which needs to be passed on.

getSignal

public ISignal getSignal()

Retrieves and removes the head of the signal queue

Returns:

Head of signal queue, null if signal queue is empty.

reportNewElement

@Deprecated
public void reportNewElement()

Deprecated. since 3.0. Is removed without replacement.

Description copied from interface: IPipe

Stages report new elements with this method.

waitForStartSignal

public final void waitForStartSignal()
                              throws InterruptedException

Throws:

InterruptedException

isClosed

public final boolean isClosed()

Returns:

true if the pipe is closed, that is, if the pipe is empty and if the source stage will not send any elements anymore (because the stage has finished its whole work); returns false in all other cases.

close

public final void close()

Description copied from interface: IPipe

May only be invoked by the input port and the owning (target) stage.