org.trianacode.taskgraph.service

Class LocalCable

java.lang.Object

org.trianacode.taskgraph.imp.CableImp

org.trianacode.taskgraph.service.LocalCable

All Implemented Interfaces:

java.io.Serializable, Cable, NodeListener, InputCable, IOCable, OutputCable

public abstract class LocalCable
extends CableImp
implements IOCable, java.io.Serializable, NodeListener

A Local input/output implementation (i.e. implements IOCable) of the GAPCable class for local delivery of data between the nodes of the connected units of this cable.

See Also:

Scheduler, Serialized Form

Field Summary

Fields inherited from class org.trianacode.taskgraph.imp.CableImp

NON_RUNNABLE_CABLE

Fields inherited from interface org.trianacode.taskgraph.Cable

CONTROL_CABLE_TYPE

Constructor Summary

Constructors

Constructor and Description
LocalCable()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(Node sendnode, Node recnode) A local cable must be created by giving a reference to a RunnableInstance object so that wehen we use non-blocking sending of data we can notify the RunnableInstance object when each packet has finished
void	createMonitor() Create a new monitor to provide the synchronisation between the OldUnit thread's.
void	destroyMonitor()
void	disconnect() Disconnect this cable from its nodes.
protected void	finalize() When the garbage collector de-allocates space from this object we reset all references to other object we have used
void	flush() Flushes the data on the pipe
boolean	isDataReady()
boolean	isDataSent()
void	nodeChildChanged(NodeEvent event) Called when one of a group node's child changes
void	nodeConnected(NodeEvent event) Called when a node is connected to a cable.
void	nodeDisconnected(NodeEvent event) Called before a node is diconnected from a cable.
void	nodeParentChanged(NodeEvent event) Called when one of a group node's parents changes
void	parameterNameSet(NodeEvent event) Called when the name of the parameter the node is inputting/outputting is set.
protected java.lang.Object	preReceive(java.lang.Object data) A method that can be over-ridden to provide additional receive functionality.
protected java.lang.Object	preSend(java.lang.Object data, boolean blocking) A method that can be over-ridden to provide additional send functionality.
void	reconnect(Node node) Reconnects the sender to this cable
java.lang.Object	recv() Returns the data from this connection if there is data there.
void	resume() Unsuspends a pipe
void	send(java.lang.Object data) Blocking call to send the data from the sending task to the receiving task.
void	sendNonBlocking(java.lang.Object data) Non-blocking call to send the data from the sending task to the receiving task.
void	suspend() Suspends the pipe.

Methods inherited from class org.trianacode.taskgraph.imp.CableImp

addCableListener, connects, contains, getReceivingNode, getReceivingTask, getSendingNode, getSendingTask, getType, isConnected, removeCableListener, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trianacode.taskgraph.Cable

addCableListener, connects, contains, getReceivingNode, getReceivingTask, getSendingNode, getSendingTask, getType, isConnected, removeCableListener

Constructor Detail

LocalCable

public LocalCable()

Method Detail

connect

public void connect(Node sendnode,
           Node recnode)
             throws CableException

A local cable must be created by giving a reference to a RunnableInstance object so that wehen we use non-blocking sending of data we can notify the RunnableInstance object when each packet has finished

Specified by:

connect in interface Cable

Overrides:

connect in class CableImp

Throws:

CableException

reconnect

public void reconnect(Node node)
               throws CableException

Reconnects the sender to this cable

Specified by:

reconnect in interface Cable

Overrides:

reconnect in class CableImp

Throws:

CableException

disconnect

public void disconnect()
                throws CableException

Disconnect this cable from its nodes.

Specified by:

disconnect in interface Cable

Overrides:

disconnect in class CableImp

Throws:

CableException

preSend

protected java.lang.Object preSend(java.lang.Object data,
                       boolean blocking)

A method that can be over-ridden to provide additional send functionality.

Parameters:

data - the data being sent

blocking - true if it is a blocking send

Returns:

the actual data to be sent

preReceive

protected java.lang.Object preReceive(java.lang.Object data)

A method that can be over-ridden to provide additional receive functionality.

Parameters:

data - the data being received

Returns:

the actual data to receive

recv

public java.lang.Object recv()

Returns the data from this connection if there is data there.

Specified by:

recv in interface InputCable

isDataSent

public boolean isDataSent()

Specified by:

isDataSent in interface OutputCable

Returns:

true if the data is ready to be collected

send

public void send(java.lang.Object data)

Blocking call to send the data from the sending task to the receiving task.

Specified by:

send in interface OutputCable

Parameters:

data - the data to be sent

sendNonBlocking

public void sendNonBlocking(java.lang.Object data)

Non-blocking call to send the data from the sending task to the receiving task.

Specified by:

sendNonBlocking in interface OutputCable

Parameters:

data - the data to be sent

createMonitor

public void createMonitor()

Create a new monitor to provide the synchronisation between the OldUnit thread's. See the Producer/Consumer example in the Java Language Tutorial for an explanation of how this works.

destroyMonitor

public void destroyMonitor()

finalize

protected void finalize()
                 throws java.lang.Throwable

When the garbage collector de-allocates space from this object we reset all references to other object we have used

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

isDataReady

public boolean isDataReady()

Specified by:

isDataReady in interface InputCable

Returns:

true if the data is ready to be collected

suspend

public void suspend()

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

Specified by:

suspend in interface InputCable

Specified by:

suspend in interface OutputCable

flush

public void flush()

Flushes the data on the pipe

Specified by:

flush in interface InputCable

Specified by:

flush in interface OutputCable

resume

public void resume()

Unsuspends a pipe

Specified by:

resume in interface InputCable

Specified by:

resume in interface OutputCable

nodeParentChanged

public void nodeParentChanged(NodeEvent event)

Called when one of a group node's parents changes

Specified by:

nodeParentChanged in interface NodeListener

nodeChildChanged

public void nodeChildChanged(NodeEvent event)

Called when one of a group node's child changes

Specified by:

nodeChildChanged in interface NodeListener

nodeConnected

public void nodeConnected(NodeEvent event)

Called when a node is connected to a cable.

Specified by:

nodeConnected in interface NodeListener

nodeDisconnected

public void nodeDisconnected(NodeEvent event)

Called before a node is diconnected from a cable.

Specified by:

nodeDisconnected in interface NodeListener

parameterNameSet

public void parameterNameSet(NodeEvent event)

Called when the name of the parameter the node is inputting/outputting is set.

Specified by:

parameterNameSet in interface NodeListener