teetime.framework.pipe

Interface IPipe<T>

Type Parameters:

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

All Known Implementing Classes:

AbstractPipe, AbstractSynchedPipe, AbstractSynchedPipe, AbstractUnsynchedPipe, AbstractUnsynchedPipe, BoundedSynchedPipe, DummyPipe, InstantiationPipe, ReflexivePipe, UnboundedSynchedPipe, UnsynchedPipe

public interface IPipe<T>

Represents a pipe that connects an output port with an input port.

Author:

Christian Wulf (chw)

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()
void	close() May only be invoked by the input port and the owning (target) stage.
OutputPort<? extends T>	getSourcePort()
InputPort<T>	getTargetPort()
boolean	hasMore()
boolean	isClosed()
boolean	isEmpty() Checks whether the pipe is empty or not.
Object	removeLast() Retrieves and removes the last element from the pipe.
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	setScheduler(PipeScheduler scheduler)
int	size()
void	waitForStartSignal()

Method Detail

add

void add(Object element)

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

Parameters:

element - to be added

addNonBlocking

boolean addNonBlocking(Object element)

Adds an element to the pipe.

Parameters:

element - Element which will be added

Returns:

true if the element could be added, false otherwise

isEmpty

boolean isEmpty()

Checks whether the pipe is empty or not.

Returns:

true if the pipe is empty, false otherwise.

size

int size()

Returns:

the current number of elements held by this pipe instance

capacity

int capacity()

Returns:

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

removeLast

Object removeLast()

Retrieves and removes the last element from the pipe.

Returns:

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

getSourcePort

OutputPort<? extends T> getSourcePort()

Returns:

the output port that is connected to the pipe.

getTargetPort

InputPort<T> getTargetPort()

Returns:

the input port that is connected to the pipe.

sendSignal

void sendSignal(ISignal signal)

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

@Deprecated
void reportNewElement()

Deprecated. since 3.0. Is removed without replacement.

Stages report new elements with this method.

isClosed

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.

hasMore

boolean hasMore()

Returns:

true if the pipe is not empty, that is, if the pipe contains at least one element.

close

void close()

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

waitForStartSignal

void waitForStartSignal()
                 throws InterruptedException

Throws:

InterruptedException

setScheduler

void setScheduler(PipeScheduler scheduler)