drcl.net.tool
Class TrafficMonitor

java.lang.Object
  |
  +--drcl.DrclObj
        |
        +--drcl.comp.Component
              |
              +--drcl.comp.Extension
                    |
                    +--drcl.net.tool.TrafficMonitor

All Implemented Interfaces:

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

public class TrafficMonitor

extends Extension

This component monitors incoming traffic (packets) and outputs throughput of the traffic. It keeps a fixed-size window of packets. The throughput at current time is then calculated by summing up the sizes of the packets in the current window divided by the window size. Then the results are exported every outputInterval second. The default window size is 5 seconds and the default output interval is one second.

This component can operate in either "byte" mode, "packet" mode or both. If the "byte" mode is enabled, the component exports the throughput, in the unit of bit/second, or bps, at the bytecount@ port. If the "packet" mode is enabled, it exports the throughput, in packet/second, at the pktcount@ port.

The first exported event is in the following format (drcl.comp.contract.EventMsg):

• Event name: "Throughput" ("byte" mode, see BYTE_COUNT_EVENT) or "Throughput (packet count)" ("packet" mode, see PKT_COUNT_EVENT).
• Event object: the calculated throughput in Double.
• Event description: null.

while the successive events are in Double.

See Also:

Serialized Form

Inner classes inherited from class drcl.comp.Component

Component.LockPack

Field Summary

static java.lang.String	BYTE_COUNT_EVENT Name of the byte-mode events.
static java.lang.String	BYTE_COUNT_PORT_ID ID of the port to export the byte-mode events.
static java.lang.String	PKT_COUNT_EVENT Name of the packet-mode events.
static java.lang.String	PKT_COUNT_PORT_ID ID of the port to export the packet-mode events.

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, lockHead, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND

Constructor Summary

TrafficMonitor()

TrafficMonitor(java.lang.String id_)

Method Summary

void	configure(double wsize_, double uint_) Configures this traffic monitor.
void	duplicate(java.lang.Object source_) Duplicates the content of source_, including ID, name, child components and connections among them, to this component.
double	getOutputInterval() Returns the output interval (in second).
double	getWindowSize() Returns the size of the measurement window (in second).
java.lang.String	info() Returns information regarding this component.
boolean	isByteModeEnabled() Returns true if the "byte" mode is enabled.
boolean	isPktModeEnabled() Returns true if the "packet" mode is enabled.
protected void	process(java.lang.Object data_, Port inPort_) The main callback method of a component.
void	reset() Resets the component for being used anew.
void	setByteModeEnabled(boolean enabled_) Enables/disables the "byte" mode.
void	setOutputInterval(double int_) Sets the output interval (in second).
void	setPktModeEnabled(boolean enabled_) Enables/disables the "packet" mode.
void	setWindowSize(double size_) Sets the size of the measurement window (in second).

Methods inherited from class drcl.comp.Extension

isExtensionEnabled, portAdded, setExtensionEnabled

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, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortNotificationEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, portRemoved, reboot, removeAll, 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

Methods inherited from class drcl.DrclObj

clone

Methods inherited from class java.lang.Object

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

Field Detail

PKT_COUNT_PORT_ID

public static final java.lang.String PKT_COUNT_PORT_ID

ID of the port to export the packet-mode events.

BYTE_COUNT_PORT_ID

public static final java.lang.String BYTE_COUNT_PORT_ID

ID of the port to export the byte-mode events.

PKT_COUNT_EVENT

public static final java.lang.String PKT_COUNT_EVENT

Name of the packet-mode events.

BYTE_COUNT_EVENT

public static final java.lang.String BYTE_COUNT_EVENT

Name of the byte-mode events.

Constructor Detail

TrafficMonitor

public TrafficMonitor()

TrafficMonitor

public TrafficMonitor(java.lang.String id_)

Method Detail

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.

Overrides:

duplicate in class Component

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

Following copied from class: drcl.comp.Component

Parameters:

data_ - the arrival data.

inPort_ - the port where the data arrives.

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

configure

public void configure(double wsize_,
                      double uint_)

Configures this traffic monitor.

Parameters:

wsize_ - the window size in second.

uint_ - the output interval in second.

setOutputInterval

public void setOutputInterval(double int_)

Sets the output interval (in second).

getOutputInterval

public double getOutputInterval()

Returns the output interval (in second).

setWindowSize

public void setWindowSize(double size_)

Sets the size of the measurement window (in second).

getWindowSize

public double getWindowSize()

Returns the size of the measurement window (in second).

setPktModeEnabled

public void setPktModeEnabled(boolean enabled_)

Enables/disables the "packet" mode.

isPktModeEnabled

public boolean isPktModeEnabled()

Returns true if the "packet" mode is enabled.

setByteModeEnabled

public void setByteModeEnabled(boolean enabled_)

Enables/disables the "byte" mode.

isByteModeEnabled

public boolean isByteModeEnabled()

Returns true if the "byte" mode is enabled.