J-Sim v1.2.1-p7 API

drcl.net.tool
Class Classifier

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Component
          extended bydrcl.net.tool.Classifier
All Implemented Interfaces:
java.lang.Cloneable, ObjectDuplicable, java.io.Serializable

public class Classifier
extends Component

The component classifies the incoming packets and pass them on at corresponding ports. Specifically, this component uses the PktClassifier to obtain an integer key for an incoming packet and then retrieves the corresponding port from its key-port map.

The class defines a set of add() and remove() methods to configure the key-port map.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class drcl.comp.Component
Component.Locks
 
Field Summary
 
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_EXPOSED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_HAS_EXPOSED_CHILD, 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
 
Constructor Summary
Classifier()
           
Classifier(java.lang.String id_)
           
 
Method Summary
 void add(int value_, int mask_, Port p_)
          Adds or replaces a mapping.
 void add(int value_, int mask_, java.lang.String portID_)
          Adds or replaces a mapping.
 void add(int value_, int mask_, java.lang.String portGroup_, java.lang.String portID_)
          Adds or replaces a mapping.
 void add(MapKey key_, Port p_)
          Adds or replaces a mapping.
 void duplicate(java.lang.Object source_)
          Duplicates the content of source_, including ID, name, child components and connections among them, to this component.
 PktClassifier getPktClassifier()
           
 java.lang.String info()
          Returns information regarding this component.
protected  void process(java.lang.Object data_, Port inPort_)
          The main callback method of a component.
 Port remove(int value_, int mask_)
          Removes a mapping.
 Port remove(MapKey key_)
          Removes a mapping.
 void removeAll()
          Removes all the mappings.
 void reset()
          Resets the component for being used anew.
 void setPktClassifier(PktClassifier pc_)
           
 
Methods inherited from class drcl.comp.Component
_resume, _start, _stop, addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, componentAdded, componentRemoved, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, finishing, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getForkManager, getID, getName, getParent, getPort, getPort, getRoot, getRuntime, getTime, iduplicate, isAncestorOf, isComponentNotificationEnabled, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortNotificationEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, portAdded, portRemoved, reboot, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setComponentNotificationEnabled, setContract, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setPortNotificationEnabled, setPortRemovable, setRuntime, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait, yield
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Classifier

public Classifier()

Classifier

public Classifier(java.lang.String id_)
Method Detail

process

protected void process(java.lang.Object data_,
                       Port inPort_)
Description copied from class: Component
The main callback method of a component. Being invoked when data arrives at a port of its.

Overrides:
process in class Component
Parameters:
data_ - the arrival data.
inPort_ - the port where the data arrives.

reset

public void reset()
Description copied from class: Component
Resets the component for being used anew. All the internal variables must be set to the initial state. All the ports and child components are reset as well.

Overrides:
reset in class Component

duplicate

public void duplicate(java.lang.Object source_)
Description copied from class: Component
Duplicates the content of source_, including ID, name, child components and connections among them, to this component. Subclasses need to override this method to copy its own variables.

Specified by:
duplicate in interface ObjectDuplicable
Overrides:
duplicate in class Component

info

public java.lang.String info()
Description copied from class: Component
Returns information regarding this component. Subclasses should override this method to provide useful information at run time.

Overrides:
info in class Component

setPktClassifier

public void setPktClassifier(PktClassifier pc_)

getPktClassifier

public PktClassifier getPktClassifier()

add

public void add(int value_,
                int mask_,
                java.lang.String portID_)
Adds or replaces a mapping.

Parameters:
value_ - value of the key.
mask_ - mask of the key.
portID_ - ID of the port to be mapped from the key.

add

public void add(int value_,
                int mask_,
                java.lang.String portGroup_,
                java.lang.String portID_)
Adds or replaces a mapping.

Parameters:
value_ - value of the key.
mask_ - mask of the key.
portID_ - ID of the port to be mapped from the key.
portGroup_ - port group ID of the port to be mapped from the key.

add

public void add(MapKey key_,
                Port p_)
Adds or replaces a mapping.

Parameters:
key_ - the key.
p_ - the port to be mapped from the key.

add

public void add(int value_,
                int mask_,
                Port p_)
Adds or replaces a mapping.

Parameters:
value_ - value of the key.
mask_ - mask of the key.
p_ - the port to be mapped from the key.

remove

public Port remove(int value_,
                   int mask_)
Removes a mapping.

Parameters:
value_ - value of the key.
mask_ - mask of the key.
Returns:
the port mapped from the key.

remove

public Port remove(MapKey key_)
Removes a mapping.

Parameters:
key_ - the key.
Returns:
the port mapped from the key.

removeAll

public void removeAll()
Removes all the mappings.

Overrides:
removeAll in class Component

J-Sim v1.2.1-p7 API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~