teetime.framework.pipe

Class AbstractUnsynchedPipe<T>

java.lang.Object

teetime.framework.AbstractPipe<T>

teetime.framework.pipe.AbstractUnsynchedPipe<T>

Type Parameters:

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

All Implemented Interfaces:

IPipe<T>

Direct Known Subclasses:

ReflexivePipe, UnsynchedPipe

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

Represents an unsynchronized pipe which can be used to connect stages within the same thread.

Author:

Christian Wulf (chw)

Field Summary

Fields inherited from class teetime.framework.AbstractPipe

cachedTargetStage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUnsynchedPipe(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.
boolean	isClosed()
void	reportNewElement() Stages report new elements with this method.
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

AbstractUnsynchedPipe

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

Method Detail

sendSignal

public final 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.

reportNewElement

public final void reportNewElement()

Description copied from interface: IPipe

Stages report new elements with this method.

isClosed

public 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 void close()

Description copied from interface: IPipe

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

waitForStartSignal

public void waitForStartSignal()
                        throws InterruptedException

Throws:

InterruptedException