drcl.inet
Class TclComponent

java.lang.Object
  drcl.DrclObj
      drcl.comp.Component
          drcl.net.Module
              drcl.inet.Protocol
                  drcl.inet.TclComponent

All Implemented Interfaces:

java.lang.Cloneable, InetConstants, ObjectCloneable, ObjectDuplicable, java.io.Serializable

public class TclComponent

extends Protocol

Component hook prototype for protocol development in Tcl. Usage: (1) for each TclComponent created in the script, call init(Interp, Object, String) to initialize the components. (2) implement two Tcl procedures: "tclcomp_process" and "tclcomp_cmd", see below for details. tclcomp_process id comp data downPort: - invoked when data arrives at the downport of a TclComponent instance - id: same id that is passed to each TclComponent instance in initialization - comp: reference to the TclComponent instance - data: arrived data - downPort: where data been received tclcomp_cmd args: - user command line interface - 1st argument: id that was assigned to the TclComponent in initialization - 2nd argument: reference to the TclComponent instance - 3rd argument: command - more argument if any: arguments to the command In the implementation of these procedures, one may access the TclComponent via the reference that is passed to the procedures. In particular, TclComponent provides a forward(Object, int, long) to make it easier for sending some data to the network.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class drcl.comp.Component

Component.Locks

Field Summary

Fields inherited from class drcl.net.Module

downPort, PortGroup_DOWN, PortGroup_UP, upPort

Fields inherited from class drcl.comp.Component

FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND

Fields inherited from interface drcl.inet.InetConstants

BYTE_MODE, DEFAULT_BANDWIDTH, DEFAULT_BUFFER_SIZE, DEFAULT_MTU, EVENT_ID_CHANGED_PORT_ID, EVENT_IDENTITY_ADDED, EVENT_IDENTITY_REMOVED, EVENT_IF_NEIGHBOR_DOWN, EVENT_IF_NEIGHBOR_UP, EVENT_IF_PORT_ID, EVENT_LINK_BROKEN, EVENT_LINK_BROKEN_PORT_ID, EVENT_MCAST_HOST_PORT_ID, EVENT_PKT_ARRIVAL, EVENT_PKT_ARRIVAL_PORT_ID, EVENT_RT_ENTRY_ADDED, EVENT_RT_ENTRY_MODIFIED, EVENT_RT_ENTRY_REMOVED, EVENT_RT_MCAST_CHANGED_PORT_ID, EVENT_RT_UCAST_CHANGED_PORT_ID, EVENT_VIF_NEIGHBOR_DOWN, EVENT_VIF_NEIGHBOR_UP, EVENT_VIF_PORT_ID, HOST_ENTRY_EXT, ID_CSL, ID_TRACE_RT, MCAST_QUERY_PORT_ID, PACKET_MODE, PID_AODV, PID_DV, PID_DVMRP, PID_HELLO, PID_IGMP, PID_OSPF, PID_RSVP, PID_TCP, PID_TRACE_RT, PID_UDP, SERVICE_CONFIGSW_PORT_ID, SERVICE_ID_PORT_ID, SERVICE_IF_PORT_ID, SERVICE_MCAST_PORT_ID, SERVICE_RT_PORT_ID, UCAST_QUERY_PORT_ID

Constructor Summary

TclComponent()

TclComponent(java.lang.String id_)

Method Summary

void	exec(java.lang.String cmd_) Hook to execute a Tcl command implemented in "tclcomp_cmd".
void	forward(java.lang.Object pkt_, int size_, long dest_) Sends data to the network.
void	init(tcl.lang.Interp interp_, java.lang.Object lock_, java.lang.String id_) Initializes the component.

Methods inherited from class drcl.inet.Protocol

broadcast, broadcast, broadcast, broadcast, broadcast, broadcast, broadcast, createConfigSwitchPort, createIDChangedEventPort, createIDServicePort, createIFEventPort, createIFQueryPort, createLinkBrokenEventPort, createMcastHostEventPort, createMcastQueryPort, createMulticastRTChangedEventPort, createPktArrivalEventPort, createRTServicePort, createUcastQueryPort, createUnicastRTChangedEventPort, createVIFEventPort, duplicate, forward, forward, forward, forward, forward, forward, LinkBrokenEventHandler

Methods inherited from class drcl.net.Module

cancelTimeout, setTimeout, setTimeoutAt

Methods inherited from class drcl.comp.Component

addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getID, getName, getParent, getPort, getPort, getRoot, getTime, iduplicate, info, isAncestorOf, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, reset, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait

Methods inherited from class drcl.DrclObj

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

TclComponent

public TclComponent()

TclComponent

public TclComponent(java.lang.String id_)

Method Detail

init

public void init(tcl.lang.Interp interp_,
                 java.lang.Object lock_,
                 java.lang.String id_)

Initializes the component. Usually, lock_ is the drcl.ruv.Shell object that contains the interpreter if the Shell has its own thread to accept commands from a terminal. If the interpreter is dedicated to this purpose, then lock_ can be the interpreter itself.

Parameters:

interp_ - the Jacl interpreter instance.

lock_ - to make sure only one thread is accessing interp_ at a time.

id_ - ID assigned to this TclComponent; will be passed to the defined Tcl procedures.

exec

public void exec(java.lang.String cmd_)

Hook to execute a Tcl command implemented in "tclcomp_cmd".

forward

public void forward(java.lang.Object pkt_,
                    int size_,
                    long dest_)

Sends data to the network. Data is wrapped in drcl.inet.InetPacket.

Parameters:

pkt_ - packet body.

size_ - packet size.

dest_ - destination address.