Compound Module NetPerfMeterHost

Package: inet.applications.netperfmeter
File: src/inet/applications/netperfmeter/NetPerfMeterHost.ned

NetPerfMeter application host.

NodeStatus IEnergyStorage IEnergyManagement IEnergyGenerator IMobility INetworkLayer IRoutingTable InterfaceTable PcapRecorder LoopbackInterface IWirelessNic IWiredNic IWiredNic IExternalNic ITunNic INetPerfMeterApp ITCP IUDP ISCTP

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name Type Description
NodeBase compound module

Contains the common lower layers (linklayer and networklayer) of Router, StandardHost, WirelessHost etc.

Networks:

Name Type Description
testNetwork network (no description)

Parameters:

Name Type Default value Description
hasStatus bool false
numExtInterfaces int 0
numRadios int 0

the number of radios in the router. by default no wireless

numPcapRecorders int 0

no of PcapRecorders.

numTunInterfaces int 0
osgModel string ""

3D model for OSG visualization, no 3D model by default

osgModelColor string ""

tint color, no colorization by default

mobilityType string numRadios > 0 ? "StationaryMobility" : ""
networkLayerType string "IPv4NetworkLayer"
routingTableType string "IPv4RoutingTable"
forwarding bool false
multicastForwarding bool false
energyStorageType string ""
energyManagementType string ""
energyGeneratorType string ""
numNetPerfMeterApps int 0

T.D. 17.11.09

tcpType string firstAvailable("TCP", "TCP_lwIP", "TCP_NSC", "TCP_None")

tcp implementation (e.g. TCP, TCP_lwIP, TCP_NSC) or TCPSpoof

udpType string firstAvailable("UDP", "UDP_None")
sctpType string firstAvailable("SCTP", "SCTP_None")

Properties:

Name Value Description
display i=device/pc2
networkNode
labels node

Gates:

Name Direction Size Description
radioIn [ ] input numRadios
pppg [ ] inout
ethg [ ] inout

Unassigned submodule parameters:

Name Type Default value Description
status.initialStatus string "UP"

TODO @signal, @statistic

routingTable.forwarding bool
routingTable.multicastForwarding bool
interfaceTable.displayAddresses bool false

whether to display IP addresses on links

pcapRecorder.verbose bool false

whether to log packets on the module output

pcapRecorder.pcapFile string ""

the PCAP file to be written

pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet

pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError

pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*] ext[*]"

space-separated list of sibling module names to listen on

pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to

pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to

pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash

lo0.lo.interfaceTableModule string

The path to the InterfaceTable module

lo0.lo.mtu int 4470B

Source code:

//
// NetPerfMeter application host.
//
module NetPerfMeterHost extends NodeBase
{
    parameters:
        @display("i=device/pc2");
        int numNetPerfMeterApps = default(0);   // T.D. 17.11.09
        string tcpType = default(firstAvailable("TCP", "TCP_lwIP", "TCP_NSC", "TCP_None"));  // tcp implementation (e.g. ~TCP, ~TCP_lwIP, ~TCP_NSC) or ~TCPSpoof
        string udpType = default(firstAvailable("UDP", "UDP_None"));
        string sctpType = default(firstAvailable("SCTP", "SCTP_None"));
        forwarding = default(false);  // disable routing by default

    submodules:
        netPerfMeterApp[numNetPerfMeterApps]: <default("NetPerfMeter")> like INetPerfMeterApp {  // T.D. 17.11.09
            parameters:
                @display("p=262,36");
        }

        tcp: <tcpType> like ITCP if (numNetPerfMeterApps > 0) {
            parameters:
                @display("p=147,141");
        }
        udp: <udpType> like IUDP if (numNetPerfMeterApps > 0) {
            parameters:
                @display("p=329,141");
        }
        sctp: <sctpType> like ISCTP if (numNetPerfMeterApps > 0) {
            @display("p=527,141");
        }

    connections allowunconnected:
        for i=0..numNetPerfMeterApps-1 {
            netPerfMeterApp[i].tcpOut --> tcp.appIn++;
            netPerfMeterApp[i].tcpIn <-- tcp.appOut++;
            netPerfMeterApp[i].sctpOut --> sctp.from_appl++;
            netPerfMeterApp[i].sctpIn <-- sctp.to_appl++;
            netPerfMeterApp[i].udpOut --> udp.appIn++;
            netPerfMeterApp[i].udpIn <-- udp.appOut++;
        }

        tcp.ipOut --> networkLayer.transportIn++ if (numNetPerfMeterApps > 0);
        tcp.ipIn <-- networkLayer.transportOut++ if (numNetPerfMeterApps > 0);
        udp.ipOut --> networkLayer.transportIn++ if (numNetPerfMeterApps > 0);
        udp.ipIn <-- networkLayer.transportOut++ if (numNetPerfMeterApps > 0);
        sctp.to_ip --> networkLayer.transportIn++ if (numNetPerfMeterApps > 0);
        networkLayer.transportOut++ --> sctp.from_ip if (numNetPerfMeterApps > 0);
}