net.clackrouter.component.base
Class PullToPush

java.lang.Object
  net.clackrouter.component.base.ClackComponent
      net.clackrouter.component.base.PullToPush

All Implemented Interfaces:

Alarm

public class PullToPush
extends ClackComponent

A simple component used to convert from a pull connection to a push connection.

For example, it could be placed to pull objects out of a queue and send them to a component that only has a push input. The must significant use is for testing, but in some cases full router configurations could benefit need such functionality.

Nested Class Summary

Nested classes/interfaces inherited from class net.clackrouter.component.base.ClackComponent

ClackComponent.Waiter

Field Summary

static int	NUM_PORTS
static int	PORT_IN
static int	PORT_OUT

Fields inherited from class net.clackrouter.component.base.ClackComponent

componentCell, m_has_error, m_log, m_name, m_num_ports, m_packetcount_in, m_packetcount_out, m_ports, mListeners, mRouter, pendingError, SIGNAL_ERROR_LEN_MSEC, UNIQUE_COUNT, view

Constructor Summary

PullToPush(Router r, java.lang.String name)

Method Summary

java.awt.Color	getColor() The color this component should be rendered in, assuming a standard component rendering by the ComponentView.ComponentRenderer class.
boolean	isModifying() Reports whether this component modifies packets passed through it This value is used by the static checking algorithm used to make sure port connections are valid.
void	poll() Everytime there is a poll() call, push any packet out our push port
protected void	setupPorts(int numports) Allocates an array of ClackPort objects to be used by this component

Methods inherited from class net.clackrouter.component.base.ClackComponent

acceptPacket, createCopy, createInputPullPort, createInputPushPort, createOutputPullPort, createOutputPushPort, error, fireListeners, getComponentCell, getHierarchicalView, getLog, getName, getNumPorts, getPacketCountIn, getPacketCountOut, getPendingError, getPort, getPropertiesView, getRouter, getSerializableProperties, getTime, getTypeName, getUniqueCount, getView, handlePullRequest, hasError, initializeProperties, isHierarchical, log, notifyAlarm, registerListener, sendOutPort, setAlarm, setComponentCell, setName, setPendingError, setView, showErrorDialog, signalError, try_repaint, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

PORT_IN

public static int PORT_IN

PORT_OUT

public static int PORT_OUT

NUM_PORTS

public static int NUM_PORTS

Constructor Detail

PullToPush

public PullToPush(Router r,
                  java.lang.String name)

Method Detail

setupPorts

protected void setupPorts(int numports)

Description copied from class: ClackComponent

Allocates an array of ClackPort objects to be used by this component

Overrides:

setupPorts in class ClackComponent

Parameters:

numports - the number of ports to create

isModifying

public boolean isModifying()

Description copied from class: ClackComponent

Reports whether this component modifies packets passed through it This value is used by the static checking algorithm used to make sure port connections are valid. Sub-classes that do not modify packets should override this method

Overrides:

isModifying in class ClackComponent

Returns:

by default, we assume the component modifies packets

poll

public void poll()

Everytime there is a poll() call, push any packet out our push port

Overrides:

poll in class ClackComponent

getColor

public java.awt.Color getColor()

Description copied from class: ClackComponent

The color this component should be rendered in, assuming a standard component rendering by the ComponentView.ComponentRenderer class.

Other renderers may ignore this value.

Overrides:

getColor in class ClackComponent

Returns:

the rendering color