org.trianacode.taskgraph.service

Interface InputCable

All Superinterfaces:

Cable

All Known Subinterfaces:

IOCable

All Known Implementing Classes:

DataCable, LocalCable, QueueCable, RunnableCable

public interface InputCable
extends Cable

Class Description Here...

Field Summary

Fields inherited from interface org.trianacode.taskgraph.Cable

CONTROL_CABLE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	flush() Flushes data in the pipe
boolean	isDataReady()
java.lang.Object	recv() Returns the data from if there is data there.
void	resume() Unsuspends a pipe
void	suspend() Suspends the pipe.

Methods inherited from interface org.trianacode.taskgraph.Cable

addCableListener, connect, connects, contains, disconnect, getReceivingNode, getReceivingTask, getSendingNode, getSendingTask, getType, isConnected, reconnect, removeCableListener

Method Detail

isDataReady

boolean isDataReady()

Returns:

true if the data is ready to be collected

recv

java.lang.Object recv()

Returns the data from if there is data there. If not then this function returns NOT_READY if the data is not ready to be received or NOT_CONNECTED if there is no cable connected to the input.

suspend

void suspend()

Suspends the pipe. Any new data sent to the pipe should be ignored.

flush

void flush()

Flushes data in the pipe

resume

void resume()

Unsuspends a pipe