StandardHost

Package: inet.node.inet

StandardHost

compound module

IPv4 host with SCTP, TCP, UDP layers and applications. IP forwarding is disabled by default (see forwarding).

  • Can be connected via ethernet interface to other nodes using the ethg gate. By default full-duplex connections are supported only (twisted pair). Set **.eth[*].typename="EthernetInterface" for a full/half-duplex CSMA/CD implementation (coaxial cable)
  • By default contains no wireless cards, however it can be configured by the numRadios parameter. Wireless card type is configured by the **.wlan[*].typename parameter. see: inet.linklayer.ieee80211 or other modules implementing IWirelessNic
  • Also external interfaces can be configured for HW in the loop simulation using the numExtInterfaces parameter and setting the type using **.ext[*].typename in the INI file. see: ExtInterface and IExternalNic
  • If wireless card is present, node mobility can be set using **.mobilityType see: inet.mobility and IMobility
status : NodeStatus

Keeps track of the status of network node (up, down, etc.) for other modules, and also displays it...

Source:
status: NodeStatus if hasStatus {
    @display("p=50,50");
} energyStorage : like IEnergyStorage

IEnergyStorage: The energy storage models describe devices that absorb energy produced by generators, and provide...

Source:
energyStorage: <energyStorageType> like IEnergyStorage if energyStorageType != "" {
    parameters:
        @display("p=50,100;i=block/plug;is=s");
} energyManagement : like IEnergyManagement

IEnergyManagement: The energy management models monitors an energy storage, estimates its state, and controls the...

Source:
energyManagement: <energyManagementType> like IEnergyManagement if energyManagementType != "" {
    parameters:
        @display("p=50,125;i=block/plug;is=s");
} energyGenerator : like IEnergyGenerator

IEnergyGenerator: The energy generator models describe the energy generation process of devices over time.

Source:
energyGenerator: <energyGeneratorType> like IEnergyGenerator if energyGeneratorType != "" {
    parameters:
        @display("p=50,150;i=block/plug;is=s");
} mobility : like IMobility

IMobility: The module interface for mobility models.

Source:
mobility: <mobilityType> like IMobility if mobilityType != "" {
    parameters:
        @display("p=53,200");
} networkLayer : like INetworkLayer

INetworkLayer: This module interface provides an abstraction for the upper and lower interfaces of different...

Source:
networkLayer: <networkLayerType> like INetworkLayer {
    parameters:
        @display("p=329,287;q=queue");
} routingTable : like IRoutingTable

IRoutingTable: This module interface provides an abstraction for different routing tables.

Source:
routingTable: <routingTableType> like IRoutingTable if routingTableType != "" {
    parameters:
        @display("p=53,250;is=s");
} interfaceTable : InterfaceTable

Keeps the table of network interfaces.

Source:
interfaceTable: InterfaceTable {
    parameters:
        @display("p=53,300;is=s");
} pcapRecorder[numPcapRecorders] : PcapRecorder

Records PCAP traces of frames sent/received by other modules within the same host.

Source:
pcapRecorder[numPcapRecorders]: PcapRecorder {
    @display("p=53,350,r,10");
} lo0 : LoopbackInterface

Loopback interface.

Source:
lo0: LoopbackInterface {
    @display("p=78,406");
} wlan[numRadios] : like IWirelessNic

Ieee80211Nic: This NIC implements an 802.11 network interface card.

Source:
wlan[numRadios]: <default("Ieee80211Nic")> like IWirelessNic {
    parameters:
        @display("p=216,406,row,60;q=queue");
} eth[sizeof(ethg)] : like IWiredNic

EthernetInterface: Ethernet network interface.

IWiredNic: Prototype module for link layer protocols.

Source:
eth[sizeof(ethg)]: <default("EthernetInterface")> like IWiredNic {
    parameters:
        @display("p=368,406,row,60;q=txQueue");
} ppp[sizeof(pppg)] : like IWiredNic

PPPInterface: PPP interface.

IWiredNic: Prototype module for link layer protocols.

Source:
ppp[sizeof(pppg)]: <default("PPPInterface")> like IWiredNic {
    parameters:
        @display("p=558,406,row,60;q=txQueue");
} ext[numExtInterfaces] : like IExternalNic

ExtInterface: Implements an interface that corresponds to a real interface on the host running the simulation.

Source:
ext[numExtInterfaces]: <default("ExtInterface")> like IExternalNic {
    parameters:
        @display("p=149,406,row,10;q=txQueue;i=block/ifcard");
} tun[numTunInterfaces] : like ITunNic

Source:
tun[numTunInterfaces]: <default("TunInterface")> like ITunNic {
    parameters:
        @display("p=213,406,row,10;q=txQueue;i=block/ifcard");
} tunApp[numTunInterfaces] : like ITunApp

ITunApp: Not an actual module type.

Source:
tunApp[numTunInterfaces]: <> like ITunApp {
    parameters:
        @display("p=280,40");
} tcpApp[numTcpApps] : like ITCPApp

ITCPApp: Template for TCP applications.

Source:
tcpApp[numTcpApps]: <> like ITCPApp {
    parameters:
        @display("p=147,54,row,60");
} tcp : like ITCP

ITCP: Interface for TCP protocol implementations.

Source:
tcp: <tcpType> like ITCP if hasTcp {
    parameters:
        @display("p=147,141");
} udpApp[numUdpApps] : like IUDPApp

IUDPApp: Template for UDP applications.

Source:
udpApp[numUdpApps]: <> like IUDPApp {
    parameters:
        @display("p=329,54,row,60");
} udp : like IUDP

IUDP: UDP protocol interface.

Source:
udp: <udpType> like IUDP if hasUdp {
    parameters:
        @display("p=329,141");
} sctpApp[numSctpApps] : like ISCTPApp

ISCTPApp: Not an actual module type.

Source:
sctpApp[numSctpApps]: <> like ISCTPApp {
    parameters:
        @display("p=527,54,row,60");
} sctp : like ISCTP

ISCTP: Interface for SCTP protocol.

Source:
sctp: <sctpType> like ISCTP if hasSctp {
    @display("p=527,141");
} pingApp[numPingApps] : like IPingApp

PingApp: To disable send, specify empty destAddr.

IPingApp: Template for ping applications.

Source:
pingApp[numPingApps]: <default("PingApp")> like IPingApp {
    parameters:
        @display("p=635,141,row,60");
}

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.

Known subclasses

Name Type Description
RTPHost compound module

TODO document!

SCTPNatRouter compound module

\IP router.

StandardHost6 compound module

IPv6 host with TCP, SCTP and UDP layers and applications. see StandardHost for configuration.

WirelessHost compound module

Models a host with (default) one wireless (802.11) card in infrastructure mode. This module is basically a StandardHost with an Ieee80211Nic with mgmtType = Ieee80211MgmtSTA added. It should be used in conjunction with AccessPoint, or any other AP model which contains Ieee80211Nic with mgmtType = Ieee80211MgmtAP.

Extends

Name Type Description
NodeBase compound module

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

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 ""
numTcpApps int 0

no of TCP apps. Specify the app types in INI file with tcpApp[0..1].typename="TCPEchoApp" syntax

numUdpApps int 0

no of UDP apps. Specify the app types in INI file with udpApp[0..1].typename="UDPVideoStreamCli" syntax

numSctpApps int 0

no of SCTP apps. Specify the app types in INI file with sctpApp[0..1].typename="SCTPServer" syntax

numPingApps int 0

no of PING apps. Specify the app types in INI file with pingApp[0..1].typename="PingApp" syntax

hasTcp bool numTcpApps > 0
hasUdp bool numUdpApps > 0
hasSctp bool numSctpApps > 0
hasTun bool numTunInterfaces > 0
tcpType string firstAvailableOrEmpty("TCP", "TCP_lwIP", "TCP_NSC")

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

udpType string firstAvailableOrEmpty("UDP")
sctpType string firstAvailableOrEmpty("SCTP")

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

//
// IPv4 host with SCTP, TCP, UDP layers and applications.
// IP forwarding is disabled by default (see forwarding).
// - Can be connected via ethernet interface to other nodes using
//   the ethg gate. By default full-duplex connections are supported
//   only (twisted pair). Set **.eth[*].typename="EthernetInterface" for
//   a full/half-duplex CSMA/CD implementation (coaxial cable)
// - By default contains no wireless cards, however it can be configured
//   by the numRadios parameter. Wireless card type is configured by the
//   **.wlan[*].typename parameter. see:  inet.linklayer.ieee80211 or other
//   modules implementing ~IWirelessNic
// - Also external interfaces can be configured for HW in the loop simulation
//   using the numExtInterfaces parameter and setting the type using
//   **.ext[*].typename in the INI file. see: ~ExtInterface and ~IExternalNic
// - If wireless card is present, node mobility can be set using **.mobilityType
//   see: inet.mobility and ~IMobility
//
module StandardHost extends NodeBase
{
    parameters:
        @display("i=device/pc2");
        int numTcpApps = default(0);  // no of TCP apps. Specify the app types in INI file with tcpApp[0..1].typename="TCPEchoApp" syntax
        int numUdpApps = default(0);  // no of UDP apps. Specify the app types in INI file with udpApp[0..1].typename="UDPVideoStreamCli" syntax
        int numSctpApps = default(0); // no of SCTP apps. Specify the app types in INI file with sctpApp[0..1].typename="SCTPServer" syntax
        int numPingApps = default(0);  // no of PING apps. Specify the app types in INI file with pingApp[0..1].typename="PingApp" syntax
        bool hasTcp = default(numTcpApps > 0);
        bool hasUdp = default(numUdpApps > 0);
        bool hasSctp = default(numSctpApps > 0);
        bool hasTun = default(numTunInterfaces > 0);
        string tcpType = default(firstAvailableOrEmpty("TCP", "TCP_lwIP", "TCP_NSC"));  // tcp implementation (e.g. ~TCP, ~TCP_lwIP, ~TCP_NSC) or ~TCPSpoof
        string udpType = default(firstAvailableOrEmpty("UDP"));
        string sctpType = default(firstAvailableOrEmpty("SCTP"));
        forwarding = default(false);  // disable routing by default
        networkLayer.proxyARP = default(false);
    submodules:
        tunApp[numTunInterfaces]: <> like ITunApp {
            parameters:
                @display("p=280,40");
        }
        tcpApp[numTcpApps]: <> like ITCPApp {
            parameters:
                @display("p=147,54,row,60");
        }
        tcp: <tcpType> like ITCP if hasTcp {
            parameters:
                @display("p=147,141");
        }
        udpApp[numUdpApps]: <> like IUDPApp {
            parameters:
                @display("p=329,54,row,60");
        }
        udp: <udpType> like IUDP if hasUdp {
            parameters:
                @display("p=329,141");
        }
        sctpApp[numSctpApps]: <> like ISCTPApp {
            parameters:
                @display("p=527,54,row,60");
        }
        sctp: <sctpType> like ISCTP if hasSctp {
            @display("p=527,141");
        }
        pingApp[numPingApps]: <default("PingApp")> like IPingApp {
            parameters:
                @display("p=635,141,row,60");
        }
    connections allowunconnected:
        for i=0..numTcpApps-1 {
            tcpApp[i].tcpOut --> tcp.appIn++;
            tcpApp[i].tcpIn <-- tcp.appOut++;
        }

        tcp.ipOut --> networkLayer.transportIn++ if hasTcp;
        tcp.ipIn <-- networkLayer.transportOut++ if hasTcp;

        for i=0..numUdpApps-1 {
            udpApp[i].udpOut --> udp.appIn++;
            udpApp[i].udpIn <-- udp.appOut++;
        }

        udp.ipOut --> networkLayer.transportIn++ if hasUdp;
        udp.ipIn <-- networkLayer.transportOut++ if hasUdp;

        for i=0..numSctpApps-1 {
            sctpApp[i].sctpOut --> sctp.from_appl++;
            sctp.to_appl++ --> sctpApp[i].sctpIn;
        }
        sctp.to_ip --> networkLayer.transportIn++ if hasSctp;
        networkLayer.transportOut++ --> sctp.from_ip if hasSctp;

        for i=0..numPingApps-1 {
            networkLayer.pingOut++ --> pingApp[i].pingIn;
            networkLayer.pingIn++ <-- pingApp[i].pingOut;
        }

        for i=0..numTunInterfaces-1 {
            tunApp[i].tunOut --> tun[i].appIn if hasTun;
            tunApp[i].tunIn <-- tun[i].appOut if hasTun;
        }
}
File: src/inet/node/inet/StandardHost.ned