ExtUpperIeee80211Interface

Package: inet.emulation.linklayer.ieee80211

ExtUpperIeee80211Interface

compound module

Provides an IEEE 802.11 network interface suitable for emulation. The upper part of the network interface is realized in the real world using a real TAP device of the host computer which is running the simulation.

pcapRecorder[numPcapRecorders] : PcapRecorder

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

Source:
pcapRecorder[numPcapRecorders]: PcapRecorder {
    parameters:
        moduleNamePatterns = ".^";
        @display("p=100,100;is=s");
} clock : like IClock

IClock: Interface for clock models.

Source:
clock: <default("")> like IClock if typename != "" {
    parameters:
        @display("p=100,200;is=s");
} mib : Ieee80211Mib

Management Information Base for IEEE 802.11 networks.

Source:
mib: Ieee80211Mib {
    parameters:
        @display("p=100,300;is=s");
} tap : ExtEthernetTapDevice

Provides a bidirectional connection to a real TAP device of the host computer which is running the...

Source:
tap: ExtEthernetTapDevice {
    parameters:
        @display("p=300,100");
} llc : like IIeee80211Llc

Ieee80211Portal: Implements the portal functionality in IEEE 802.11 networks, serving as a bridge between wireless...

IIeee80211Llc: Module interface for IEEE 802.11 Logical Link Control (LLC) implementations.

Source:
llc: <default("Ieee80211Portal")> like IIeee80211Llc {
    parameters:
        @display("p=300,200");
} classifier : like IIeee8021dQosClassifier

OmittedIeee8021dQosClassifier: Implements the given module interface and can be used as an omitted optional module that removes...

IIeee8021dQosClassifier: Interface for 802.1d QoS classifiers.

Source:
classifier: <default("OmittedIeee8021dQosClassifier")> like IIeee8021dQosClassifier {
    parameters:
        @display("p=500,150");
} agent : like IIeee80211Agent

Ieee80211AgentSta: Used in 802.11 infrastructure mode: in a station (STA), this module controls channel scanning,...

IIeee80211Agent: Module interface for IEEE 802.11 agent modules that provide the decision logic for selecting access...

Source:
agent: <default("Ieee80211AgentSta")> like IIeee80211Agent if typename != "" {
    parameters:
        @display("p=700,300");
} mgmt : like IIeee80211Mgmt

Ieee80211MgmtSta: Used in 802.11 infrastructure mode: handles management frames for a station (STA).

IIeee80211Mgmt: Module interface for all IEEE 802.11 management module types.

Source:
mgmt: <default("Ieee80211MgmtSta")> like IIeee80211Mgmt {
    parameters:
        @display("p=500,300");
} mac : like IIeee80211Mac

Ieee80211Mac: Implementation of the 802.11 MAC protocol.

IIeee80211Mac: Module interface for the IEEE 802.11 MAC module type.

Source:
mac: <default("Ieee80211Mac")> like IIeee80211Mac {
    parameters:
        @display("p=300,300");
} radio : like IRadio

Ieee80211Radio: This radio model is part of the IEEE 802.11 physical layer model.

IRadio: Module interface for radio modules.

Source:
radio: <default("Ieee80211Radio")> like IRadio {
    parameters:
        @display("p=300,400");
}

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
ExtInterface compound module

A base for external network interfaces, network interface modules that connect the simulation to the network stack of the host OS.

Parameters

Name Type Default value Description
displayStringTextFormat string "%a (%i)\n%m"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
isWireless bool false
interfaceTableModule string

Module path of the interface table module

device string

Name of the attached OS device (e.g. tap0, veth0, etc.)

namespace string ""

Name of the OS network namespace (optional)

copyConfiguration string ""

Copy interface configuration such as MAC address, IP address, and MTU from/to the external interface.

address string "auto"
broadcast bool true
multicast bool true
pointToPoint bool false
mtu int 4470B
energySourceModule string ""
opMode string "g(mixed)"
bitrate double -1bps

Properties

Name Value Description
class ExtInterface
networkInterface
lifecycleSupport
display i=block/ifcard

Gates

Name Direction Size Description
upperLayerIn input
upperLayerOut output
radioIn input

To receive signals

Signals

Name Type Unit Description
packetDropped inet::Packet

Statistics

Name Title Source Record Unit Interpolation Mode Description
packetDropInterfaceDown packet drops: interface down packetDropReasonIsInterfaceDown(packetDropped) count, sum(packetBytes), vector(packetBytes) none
packetDropNoCarrier packet drops: no carrier packetDropReasonIsNoCarrier(packetDropped) count, sum(packetBytes), vector(packetBytes) none

Unassigned submodule parameters

Name Type Default value Description
pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

pcapRecorder.verbose bool true

Whether to log packets on the module output

pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not

pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not

pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"

pcapRecorder.fileFormat string "pcapng"
pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet

pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).

pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError

pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to

pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to

pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class

pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default

pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"

pcapRecorder.alwaysFlush bool false

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

mib.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

tap.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

tap.device string

Name of the existing real tap interface

tap.namespace string ""
tap.packetNameFormat string "Ext-%p-%t-%n"
mgmt.macModule string

The path to the MAC module

Source code

//
// Provides an IEEE 802.11 network interface suitable for emulation.
// The upper part of the network interface is realized in the real world using
// a real TAP device of the host computer which is running the simulation.
//
module ExtUpperIeee80211Interface extends ExtInterface like IWirelessInterface
{
    parameters:
        string energySourceModule = default("");
        string opMode @enum("a","b","g(erp)","g(mixed)","n(mixed-2.4Ghz)","p","ac") = default("g(mixed)");
        double bitrate @unit(bps) = default(-1bps);
        **.opMode = this.opMode;
        **.bitrate = this.bitrate;
        mac.modeSet = default(this.opMode);
        mac.*.rateSelection.dataFrameBitrate = default(this.bitrate);
        radio.signalAnalogRepresentation = default("scalar");
        *.macModule = default(absPath(".mac"));
        *.mibModule = default(absPath(".mib"));
        *.interfaceTableModule = default(absPath(this.interfaceTableModule));
        *.energySourceModule = default(absPath(this.energySourceModule));
    gates:
        input radioIn @labels(IWirelessSignal); // To receive signals
    submodules:
        mib: Ieee80211Mib {
            parameters:
                @display("p=100,300;is=s");
        }
        tap: ExtEthernetTapDevice {
            parameters:
                @display("p=300,100");
        }
        llc: <default("Ieee80211Portal")> like IIeee80211Llc {
            parameters:
                @display("p=300,200");
        }
        classifier: <default("OmittedIeee8021dQosClassifier")> like IIeee8021dQosClassifier {
            parameters:
                @display("p=500,150");
        }
        agent: <default("Ieee80211AgentSta")> like IIeee80211Agent if typename != "" {
            parameters:
                @display("p=700,300");
        }
        mgmt: <default("Ieee80211MgmtSta")> like IIeee80211Mgmt {
            parameters:
                @display("p=500,300");
        }
        mac: <default("Ieee80211Mac")> like IIeee80211Mac {
            parameters:
                @display("p=300,300");
        }
        radio: <default("Ieee80211Radio")> like IRadio {
            parameters:
                @display("p=300,400");
        }
    connections allowunconnected:
        radioIn --> { @display("m=s"); } --> radio.radioIn;
        radio.upperLayerIn <-- mac.lowerLayerOut;
        radio.upperLayerOut --> mac.lowerLayerIn;

        mac.mgmtOut --> mgmt.macIn;
        mac.mgmtIn <-- mgmt.macOut;

        mgmt.agentOut --> agent.mgmtIn if exists(agent);
        mgmt.agentIn <-- agent.mgmtOut if exists(agent);

        llc.upperLayerOut --> { @display("m=n"); } --> tap.lowerLayerIn;
        llc.upperLayerIn <-- { @display("m=n"); } <-- classifier.out;

        llc.lowerLayerOut --> mac.upperLayerIn;
        llc.lowerLayerIn <-- mac.upperLayerOut;

        classifier.in <-- { @display("m=n"); } <-- tap.lowerLayerOut;
}

File: src/inet/emulation/linklayer/ieee80211/ExtUpperIeee80211Interface.ned