LMacInterface

Package: inet.linklayer.lmac

compound module LMacInterface

Implements a wireless network interface using the L-MAC protocol.

LMacInterfaceupperLayerIn --> classifier.in inherited from WirelessInterfaceclassifier.out --> queue.in inherited from WirelessInterfacequeue.out --> mac.upperLayerIn inherited from WirelessInterfacemac.lowerLayerOut --> radio.upperLayerIn inherited from WirelessInterface conditional: exists(radio)?radioIn --> radio.radioIn inherited from WirelessInterface conditional: exists(radio)?radio.upperLayerOut --> mac.lowerLayerIn inherited from WirelessInterface conditional: exists(radio)?mac.upperLayerOut --> upperLayerOut inherited from WirelessInterfacepcapRecorder[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"); }clockclassifier: inet.linklayer.common.OmittedIeee8021dQosClassifier (like IIeee8021dQosClassifier) inherited from WirelessInterface 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=200,100"); }classifierqueue: inet.queueing.queue.DropTailQueue (like IPacketQueue) inherited from WirelessInterface DropTailQueue: A limited packet queue that drops packets at the tail of the queue. IPacketQueue: Interface for packet queue modules. Source: queue: <default("OmittedPacketQueue")> like IPacketQueue { parameters: @display("p=200,200;q=l2queue"); }#queuemac: inet.linklayer.lmac.LMac (like IMacProtocol) inherited from WirelessInterface LMac: Implementation of L-MAC (Lightweight Medium Access Protocol for Wireless Sensor Networks). IMacProtocol: This interface provides an abstraction for different MAC protocols. Source: mac: <> like IMacProtocol { parameters: @display("p=300,200"); }macradio: inet.physicallayer.wireless.apsk.packetlevel.ApskRadio (like IRadio) inherited from WirelessInterface ApskRadio: This radio model provides a hypothetical radio that simply uses one of the well-known modulations... IRadio: Module interface for radio modules. Source: radio: <default("")> like IRadio if typename != "" { parameters: @display("p=300,300"); }radio

Inheritance diagram

Extends

Name

Type

Description

WirelessInterface

compound module

Implements a generic wireless network interface.

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

protocol

string

“”

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

queue.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

queue.packetCapacity

int

100

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

queue.dataCapacity

int

-1b

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

queue.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

queue.comparatorClass

string

“”

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

queue.bufferModule

string

“”

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

Source code

//
// Implements a wireless network interface using the L-MAC protocol.
//
module LMacInterface extends WirelessInterface
{
    parameters:
        radio.typename = default("ApskRadio");
        mac.typename = "LMac";
        queue.typename = default("DropTailQueue");
        queue.packetCapacity = default(10);
}

File: src/inet/linklayer/lmac/LMacInterface.ned