Simple Module BGTrafficSinkApp

Package: core4inet.applications.trafficsink.base
File: src/core4inet/applications/trafficsink/base/BGTrafficSinkApp.ned

C++ definition

Traffic sink application used for statistics collection of best-effort traffic.

See also: ~TrafficSinkApp

Author: Till Steinbach

BGTrafficSinkApp

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram. Click here to see the full picture.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram. Click here to see the full picture.

Extends:

Name Type Description
TrafficSinkApp simple module

Traffic sink application used for statistics collection.

Parameters:

Name Type Default value Description
displayName string ""

Name shown above the module

buffers string "bgOut"

Comma seperated list of buffer modules the application is allowed to use

buffers_manual bool false

If true, buffer management is not used. Applications use their own methods to locate buffers

srcAddress string "00:00:00:00:00:00"

Source MAC address empty or 00:00:00:00:00:00 means all

reply bool false

Replay each frame;

replyFirst bool true

Replay first frame to update tables in switches;

Properties:

Name Value Description
class BGTrafficSinkApp
display i=block/sink,green

Gates:

Name Direction Size Description
schedulerIn input

Input gate for the incoming Scheduler messages

in input

Input gate for the incoming best-effort messages

Signals:

Name Type Unit
rxPk inet::EtherFrame

Statistics:

Name Title Source Record Unit Interpolation Mode
rxLatency End-to-end latency messageAge(rxPk) stats, histogram?, vector s none
rxBytes Received Bytes rxPk sum(packetBytes), vector(packetBytes), histogram(packetBytes)?, floatingIntervalSumVector(packetBytes)? B none
rxPk Received Packets rxPk count packets
rxLatencyInner End-to-end latency inner messageAge(innerMessage(rxPk)) stats, histogram?, vector s none

Source code:

//
// Traffic sink application used for statistics collection of best-effort traffic.
//
// @see ~TrafficSinkApp
//
// @author Till Steinbach
//
simple BGTrafficSinkApp extends TrafficSinkApp
{
    parameters:
        @class(BGTrafficSinkApp);
        @display("i=block/sink,green");

        //Source MAC address empty or 00:00:00:00:00:00 means all
        string srcAddress = default("00:00:00:00:00:00");
        //Replay each frame;
        bool reply = default(false);
        //Replay first frame to update tables in switches;
        bool replyFirst = default(true);

        //Default bgOut is best-effort buffer
        buffers = default("bgOut");
    gates:
        //Input gate for the incoming best-effort messages
        input in @directIn @labels(EtherFrame);
}