Ieee80211Interface

Package: inet.linklayer.ieee80211

compound module Ieee80211Interface

Implements an IEEE 802.11 network interface. It implements a large subset of the IEEE 802.11 standard, and may use radio models and wireless signal representations of varying levels of detail. It is also extremely configurable, and its component structure makes it easy to experiment with various details of the protocol.

The main components of the interface are the MAC and the radio submodules. Most configuration parameters are in the MAC (Ieee80211Mac) and its numerous subcomponents. Most subcomponents are replaceable to facilitate experimentation by using typename assignments in the configuration.

The default radio is Ieee80211ScalarRadio, but it can be replaced with any of several compatible radio types using typename assignments in the configuration. Several radio models of varying levels of detail are available, from simple unit disk radio models to layered radio models that explicitly model forward error correction, scrambling, symbol encoding/decoding, etc, and may represent radio signals with a multi-dimensional power density function over time and frequency. The INET User Guide elaborates on the possibilities.

The type of the management submodule is also configurable. The type of this submodule decides whether the interfaces acts as an AP, a STA, or is in ad hoc mode. Use Ieee80211MgmtSta or Ieee80211MgmtStaSimplified for STA, Ieee80211MgmtAp or Ieee80211MgmtApSimplified for AP, and Ieee80211MgmtAdhoc for ad hoc mode.

The agent submodule is responsible for initiating the process of connecting to an AP and similar tasks normally done from “user space”.

The LLC submodule is responsible for adding/removing the LLC header on packets.

A classifier is responsible for assigning a 802.1d User Priority (UP) to packets and is only needed if QoS is involved.

The clock submodule would allow clock skew modeling – this is currently not used.

Note about the implementation:

Despite its appearance, Ieee80211Interface is not a plain compound module. It has an underlying custom C++ class that inherits from cModule.

Ieee80211InterfaceradioIn --> radio.radioInradio.upperLayerIn --> mac.lowerLayerOutradio.upperLayerOut --> mac.lowerLayerInmac.mgmtOut --> mgmt.macInmac.mgmtIn --> mgmt.macOutmgmt.agentOut --> agent.mgmtIn conditional: exists(agent)?mgmt.agentIn --> agent.mgmtOut conditional: exists(agent)?llc.upperLayerOut --> upperLayerOutllc.upperLayerIn --> classifier.outllc.lowerLayerOut --> mac.upperLayerInllc.lowerLayerIn --> mac.upperLayerOutclassifier.in --> upperLayerInpcapRecorder[numPcapRecorders]: inet.common.packet.recorder.PcapRecorder inherited from NetworkInterface 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"); }pcapRecorder[numPcapRecorders]clock: inet.clock.contract.IClock (like IClock) inherited from NetworkInterface IClock: Interface for clock models. Source: clock: <default("")> like IClock if typename != "" { parameters: @display("p=100,200;is=s"); }clockmib: inet.linklayer.ieee80211.mib.Ieee80211Mib Management Information Base for IEEE 802.11 networks. Source: mib: Ieee80211Mib { parameters: @display("p=100,300;is=s"); }mibllc: inet.linklayer.ieee80211.llc.IIeee80211Llc (like IIeee80211Llc) IIeee80211Llc: Module interface for IEEE 802.11 Logical Link Control (LLC) implementations. Source: llc: <default(opMode == "p" ? "Ieee80211LlcEpd" : "Ieee80211LlcLpd")> like IIeee80211Llc { parameters: @display("p=300,200"); }llcclassifier: inet.linklayer.common.OmittedIeee8021dQosClassifier (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,100"); }classifieragent: inet.linklayer.ieee80211.mgmt.Ieee80211AgentSta (like IIeee80211Agent) Ieee80211AgentSta: Used in 802.11 infrastructure mode: in a station (STA), this module controls channel scanning, as... IIeee80211Agent: Module interface for IEEE 802.11 agent modules that provide the decision logic for selecting acce... Source: agent: <default("Ieee80211AgentSta")> like IIeee80211Agent if typename != "" { parameters: @display("p=700,300"); }agentmgmt: inet.linklayer.ieee80211.mgmt.Ieee80211MgmtSta (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"); }mgmtmac: inet.linklayer.ieee80211.mac.Ieee80211Mac (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"); }macradio: inet.physicallayer.wireless.ieee80211.packetlevel.Ieee80211Radio (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"); }radio

Usage diagram

Inheritance diagram

Used in compound modules

Name

Type

Description

LinkLayerNodeBase

compound module

An extension of the basic node infrastructure with link layer functionality. Provides support for various network interfaces and link layer protocols, forming the foundation for network connectivity.

AccessPoint

compound module

A wireless access point device that connects wireless stations (like WirelessHost) to a wired network. Supports multiple wireless radios and multiple Ethernet ports.

Extends

Name

Type

Description

NetworkInterface

compound module

Serves as the base module for all network interfaces.

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

interfaceTableModule

string

energySourceModule

string

“”

opMode

string

“g(mixed)”

address

string

“auto”

MAC address as hex string (12 hex digits), or

protocol

string

“”

“auto”. “auto” values will be replaced by a generated MAC address in init stage 0.

bitrate

double

-1bps

Properties

Name

Value

Description

class

NetworkInterface

display

i=block/ifcard

lifecycleSupport

networkInterface

Gates

Name

Direction

Size

Description

upperLayerIn

input

upperLayerOut

output

radioIn

input

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

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

“Address: {address}{ssidStr}\n{modeStr}{stationTypeStr}{qosStr}{associatedStr}”

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

agent.displayStringTextFormat

string

“”

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

agent.interfaceTableModule

string

The path to the InterfaceTable module

agent.mibModule

string

agent.activeScan

bool

true

Selects between active and passive scanning

agent.channelsToScan

string

“”

List of channel numbers to scan (space delimited); empty means all channels

agent.probeDelay

double

100ms

Delay before sending a probe request during active scanning

agent.minChannelTime

double

150ms

Min interval to spend on a channel during active scanning

agent.maxChannelTime

double

300ms

Channel time for passive scanning, and max channel time for active scanning

agent.authenticationTimeout

double

5s

Timeout for the authentication procedure

agent.associationTimeout

double

5s

Timeout for the association procedure

agent.startingTime

double

-1s

Agent starting time.

agent.defaultSsid

string

“”

List of allowed SSIDs to connect to; leave empty for no filtering

mgmt.displayStringTextFormat

string

“”

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

mgmt.interfaceTableModule

string

The path to the InterfaceTable module

mgmt.numChannels

int

1

Number of channels to scan

mgmt.mibModule

string

mgmt.macModule

string

The path to the MAC module

mac.dcf.channelAccess.pendingQueue.displayStringTextFormat

string

“contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d”

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

mac.dcf.channelAccess.pendingQueue.packetCapacity

int

100

Maximum number of packets in the queue, no limit by default

mac.dcf.channelAccess.pendingQueue.dataCapacity

int

-1b

Maximum total length of packets in the queue, no limit by default

mac.dcf.channelAccess.pendingQueue.dropperClass

string

“inet::queueing::PacketAtCollectionEndDropper”

Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class

mac.dcf.channelAccess.pendingQueue.comparatorClass

string

“inet::ieee80211::MgmtOverDataComparator”

Determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class

mac.dcf.channelAccess.pendingQueue.bufferModule

string

“”

Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default

mac.dcf.channelAccess.inProgressFrames.displayStringTextFormat

string

“{numInProgress} packets”

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

mac.dcf.channelAccess.inProgressFrames.pendingQueueModule

string

“^.pendingQueue”

mac.dcf.channelAccess.inProgressFrames.originatorMacDataServiceModule

string

“^.^.originatorMacDataService”

mac.dcf.channelAccess.inProgressFrames.ackHandlerModule

string

“^.^.ackHandler”

mac.dcf.channelAccess.contention.displayStringTextFormat

string

“{fsmState}”

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

mac.dcf.channelAccess.contention.initialChannelBusy

bool

true

Assume that the channel was busy before the simulation started

mac.dcf.channelAccess.contention.backoffOptimization

bool

true

We can pretend the frame has arrived into the queue a little bit earlier, and maybe able to start transmitting immediately

mac.dcf.originatorMacDataService.fragmentationPolicy.displayStringTextFormat

string

“”

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

mac.dcf.originatorMacDataService.fragmentationPolicy.fragmentationThreshold

int

1500B

mac.dcf.rateSelection.displayStringTextFormat

string

“”

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

mac.dcf.rateSelection.multicastFrameBitrate

double

-1bps

mac.dcf.rateSelection.responseAckFrameBitrate

double

-1bps

mac.dcf.rateSelection.responseCtsFrameBitrate

double

-1bps

mac.dcf.rateSelection.dataFrameBitrate

double

-1bps

Fastest

mac.dcf.rateSelection.dataFrameBandwidth

double

nan Hz

Unspecified by default

mac.dcf.rateSelection.dataFrameNumSpatialStreams

int

-1

Unspecified by default

mac.dcf.rateSelection.mgmtFrameBitrate

double

-1bps

Fastest

mac.dcf.rateSelection.controlFrameBitrate

double

-1bps

mac.dcf.recoveryProcedure.displayStringTextFormat

string

“”

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

mac.dcf.recoveryProcedure.shortRetryLimit

int

7

mac.dcf.recoveryProcedure.longRetryLimit

int

4

mac.dcf.originatorProtectionMechanism.displayStringTextFormat

string

“”

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

mac.dcf.originatorProtectionMechanism.rateSelectionModule

string

mac.dcf.ackHandler.displayStringTextFormat

string

“”

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

mac.dcf.originatorAckPolicy.displayStringTextFormat

string

“”

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

mac.dcf.originatorAckPolicy.rateSelectionModule

string

mac.dcf.originatorAckPolicy.ackTimeout

double

-1s

mac.dcf.recipientAckPolicy.displayStringTextFormat

string

“”

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

mac.dcf.recipientAckPolicy.rateSelectionModule

string

mac.dcf.rtsPolicy.displayStringTextFormat

string

“”

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

mac.dcf.rtsPolicy.rateSelectionModule

string

mac.dcf.rtsPolicy.ctsTimeout

double

-1s

mac.dcf.rtsPolicy.rtsThreshold

int

2346B

mac.dcf.ctsPolicy.displayStringTextFormat

string

“”

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

mac.dcf.ctsPolicy.rxModule

string

mac.dcf.ctsPolicy.rateSelectionModule

string

mac.hcf.edca.edcaf.pendingQueue.displayStringTextFormat

string

“contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d”

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

mac.hcf.edca.edcaf.pendingQueue.packetCapacity

int

100

Maximum number of packets in the queue, no limit by default

mac.hcf.edca.edcaf.pendingQueue.dataCapacity

int

-1b

Maximum total length of packets in the queue, no limit by default

mac.hcf.edca.edcaf.pendingQueue.dropperClass

string

“inet::queueing::PacketAtCollectionEndDropper”

Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class

mac.hcf.edca.edcaf.pendingQueue.comparatorClass

string

“inet::ieee80211::MgmtOverDataComparator”

Determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class

mac.hcf.edca.edcaf.pendingQueue.bufferModule

string

“”

Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default

mac.hcf.edca.edcaf.inProgressFrames.displayStringTextFormat

string

“{numInProgress} packets”

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

mac.hcf.edca.edcaf.inProgressFrames.pendingQueueModule

string

“^.pendingQueue”

mac.hcf.edca.edcaf.inProgressFrames.originatorMacDataServiceModule

string

“^.^.^.originatorMacDataService”

mac.hcf.edca.edcaf.inProgressFrames.ackHandlerModule

string

“^.ackHandler”

mac.hcf.edca.edcaf.contention.displayStringTextFormat

string

“{fsmState}”

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

mac.hcf.edca.edcaf.contention.initialChannelBusy

bool

true

Assume that the channel was busy before the simulation started

mac.hcf.edca.edcaf.contention.backoffOptimization

bool

true

We can pretend the frame has arrived into the queue a little bit earlier, and maybe able to start transmitting immediately

mac.hcf.edca.edcaf.ackHandler.displayStringTextFormat

string

“”

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

mac.hcf.edca.edcaf.txopProcedure.displayStringTextFormat

string

“”

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

mac.hcf.edca.edcaf.txopProcedure.txopLimit

double

-1s

mac.hcf.edca.edcaf.recoveryProcedure.displayStringTextFormat

string

“”

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

mac.hcf.edca.edcaf.recoveryProcedure.shortRetryLimit

int

7

mac.hcf.edca.edcaf.recoveryProcedure.longRetryLimit

int

4

mac.hcf.edca.collisionController.displayStringTextFormat

string

“”

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

mac.hcf.edca.mgmtAndNonQoSRecoveryProcedure.displayStringTextFormat

string

“”

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

mac.hcf.edca.mgmtAndNonQoSRecoveryProcedure.shortRetryLimit

int

7

mac.hcf.edca.mgmtAndNonQoSRecoveryProcedure.longRetryLimit

int

4

mac.hcf.hcca.displayStringTextFormat

string

“”

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

mac.hcf.originatorMacDataService.msduAggregationPolicy.displayStringTextFormat

string

“”

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

mac.hcf.originatorMacDataService.msduAggregationPolicy.subframeNumThreshold

int

-1

Minimum number of subframes needed to compose an A-MSDU. (-1 means it won’t be checked)

mac.hcf.originatorMacDataService.msduAggregationPolicy.aggregationLengthThreshold

int

-1

The minimum length for an aggregated payload necessary to create an A-MSDU (-1 means it won’t be checked).

mac.hcf.originatorMacDataService.msduAggregationPolicy.maxAMsduSize

int

4065

-1 means infinity

mac.hcf.originatorMacDataService.msduAggregationPolicy.qOsCheck

bool

true

Turns on/off the check of the presence of the QoS flag (false means off – this is needed for aggregation in DCF mode).

mac.hcf.originatorMacDataService.mpduAggregationPolicy.displayStringTextFormat

string

“”

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

mac.hcf.originatorMacDataService.fragmentationPolicy.displayStringTextFormat

string

“”

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

mac.hcf.originatorMacDataService.fragmentationPolicy.fragmentationThreshold

int

1500B

mac.hcf.singleProtectionMechanism.displayStringTextFormat

string

“”

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

mac.hcf.singleProtectionMechanism.rateSelectionModule

string

mac.hcf.rateSelection.displayStringTextFormat

string

“”

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

mac.hcf.rateSelection.multicastFrameBitrate

double

-1bps

mac.hcf.rateSelection.responseAckFrameBitrate

double

-1bps

mac.hcf.rateSelection.responseBlockAckFrameBitrate

double

-1bps

mac.hcf.rateSelection.responseCtsFrameBitrate

double

-1bps

mac.hcf.rateSelection.dataFrameBitrate

double

-1bps

Fastest

mac.hcf.rateSelection.dataFrameBandwidth

double

nan Hz

Unspecified by default

mac.hcf.rateSelection.dataFrameNumSpatialStreams

int

-1

Unspecified by default

mac.hcf.rateSelection.mgmtFrameBitrate

double

-1bps

Fastest

mac.hcf.rateSelection.controlFrameBitrate

double

-1bps

mac.hcf.originatorAckPolicy.displayStringTextFormat

string

“”

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

mac.hcf.originatorAckPolicy.rateSelectionModule

string

mac.hcf.originatorAckPolicy.blockAckReqThreshold

int

5

mac.hcf.originatorAckPolicy.maxBlockAckPolicyFrameLength

int

1000B

mac.hcf.originatorAckPolicy.blockAckTimeout

double

-1s

mac.hcf.originatorAckPolicy.ackTimeout

double

-1s

mac.hcf.recipientAckPolicy.displayStringTextFormat

string

“”

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

mac.hcf.recipientAckPolicy.rateSelectionModule

string

mac.hcf.rtsPolicy.displayStringTextFormat

string

“”

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

mac.hcf.rtsPolicy.rateSelectionModule

string

mac.hcf.rtsPolicy.ctsTimeout

double

-1s

mac.hcf.rtsPolicy.rtsThreshold

int

2346B

mac.hcf.ctsPolicy.displayStringTextFormat

string

“”

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

mac.hcf.ctsPolicy.rxModule

string

mac.hcf.ctsPolicy.rateSelectionModule

string

mac.hcf.originatorBlockAckAgreementPolicy.displayStringTextFormat

string

“”

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

mac.hcf.originatorBlockAckAgreementPolicy.delayedAckPolicySupported

bool

false

mac.hcf.originatorBlockAckAgreementPolicy.aMsduSupported

bool

true

mac.hcf.originatorBlockAckAgreementPolicy.maximumAllowedBufferSize

int

64

mac.hcf.originatorBlockAckAgreementPolicy.blockAckTimeoutValue

double

0s

0 means that it depends on the originator

mac.hcf.recipientBlockAckAgreementPolicy.displayStringTextFormat

string

“”

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

mac.hcf.recipientBlockAckAgreementPolicy.delayedAckPolicySupported

bool

false

mac.hcf.recipientBlockAckAgreementPolicy.aMsduSupported

bool

true

mac.hcf.recipientBlockAckAgreementPolicy.maximumAllowedBufferSize

int

64

mac.hcf.recipientBlockAckAgreementPolicy.blockAckTimeoutValue

double

0s

0 means that it depends on the originator

mac.ds.displayStringTextFormat

string

“”

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

mac.ds.mibModule

string

mac.rx.displayStringTextFormat

string

“{rxStatus}”

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

mac.tx.displayStringTextFormat

string

“{txFramePrefix}{txState}”

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

mac.tx.rxModule

string

Source code

//
// Implements an IEEE 802.11 network interface. It implements
// a large subset of the IEEE 802.11 standard, and may use radio models
// and wireless signal representations of varying levels of detail.
// It is also extremely configurable, and its component structure makes
// it easy to experiment with various details of the protocol.
//
// The main components of the interface are the MAC and the radio submodules.
// Most configuration parameters are in the MAC (~Ieee80211Mac) and its
// numerous subcomponents. Most subcomponents are replaceable to facilitate
// experimentation by using typename assignments in the configuration.
//
// The default radio is ~Ieee80211ScalarRadio, but it can be replaced
// with any of several compatible radio types using typename assignments
// in the configuration. Several radio models of varying levels of detail
// are available, from simple unit disk radio models to layered radio models
// that explicitly model forward error correction, scrambling, symbol
// encoding/decoding, etc, and may represent radio signals with a
// multi-dimensional power density function over time and frequency.
// The INET User Guide elaborates on the possibilities.
//
// The type of the management submodule is also configurable. The type of this
// submodule decides whether the interfaces acts as an AP, a STA, or is in ad hoc mode.
// Use ~Ieee80211MgmtSta or ~Ieee80211MgmtStaSimplified for STA,
// ~Ieee80211MgmtAp or ~Ieee80211MgmtApSimplified for AP, and
// ~Ieee80211MgmtAdhoc for ad hoc mode.
//
// The agent submodule is responsible for initiating the process of connecting
// to an AP and similar tasks normally done from "user space".
//
// The LLC submodule is responsible for adding/removing the LLC header on packets.
//
// A classifier is responsible for assigning a 802.1d User Priority (UP) to
// packets and is only needed if QoS is involved.
//
// The clock submodule would allow clock skew modeling -- this is currently not used.
//
// Note about the implementation:
//
// Despite its appearance, Ieee80211Interface is not a plain compound module.
// It has an underlying custom C++ class that inherits from `cModule`.
//
module Ieee80211Interface extends NetworkInterface like IWirelessInterface
{
    parameters:
        string interfaceTableModule;
        string energySourceModule = default("");
        string opMode @enum("a","b","g(erp)","g(mixed)","n(mixed-2.4Ghz)","p","ac") = default("g(mixed)");
        string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or
                                                   // "auto". "auto" values will be replaced by
                                                   // a generated MAC address in init stage 0.
        string protocol = default("");
        double bitrate @unit(bps) = default(-1bps);
        **.opMode = this.opMode;
        **.bitrate = this.bitrate;
        mac.modeSet = default(this.opMode);
        mac.*.rateSelection.dataFrameBitrate = default(this.bitrate);
        *.macModule = default(absPath(".mac"));
        *.mibModule = default(absPath(".mib"));
        *.interfaceTableModule = default(absPath(this.interfaceTableModule));
        *.energySourceModule = default(absPath(this.energySourceModule));
    gates:
        input upperLayerIn;
        output upperLayerOut;
        input radioIn @labels(IWirelessSignal);
    submodules:
        mib: Ieee80211Mib {
            parameters:
                @display("p=100,300;is=s");
        }
        llc: <default(opMode == "p" ? "Ieee80211LlcEpd" : "Ieee80211LlcLpd")> like IIeee80211Llc {
            parameters:
                @display("p=300,200");
        }
        classifier: <default("OmittedIeee8021dQosClassifier")> like IIeee8021dQosClassifier {
            parameters:
                @display("p=500,100");
        }
        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:
        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"); } --> upperLayerOut;
        llc.upperLayerIn <-- { @display("m=n"); } <-- classifier.out;

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

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

File: src/inet/linklayer/ieee80211/Ieee80211Interface.ned