WirelessInterface¶

compound module WirelessInterface

Implements a generic wireless network interface.

Usage diagram¶

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
BMacInterface	compound module	Implements a wireless network interface using the B-MAC protocol.
CsmaCaInterface	compound module	Module interface for CSMA/CA network interfaces.
LMacInterface	compound module	Implements a wireless network interface using the L-MAC protocol.
ShortcutInterface	compound module	Implements a simplistic network interface that uses a shortcut to the receiver at the MAC layer.
XMacInterface	compound module	Implements a wireless network interface using the X-MAC protocol.

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

Source code¶

//
// Implements a generic wireless network interface.
//
module WirelessInterface extends NetworkInterface like IWirelessInterface
{
    parameters:
        string interfaceTableModule;
        string energySourceModule;
        string protocol = default("");
        *.interfaceTableModule = default(absPath(this.interfaceTableModule));
        *.energySourceModule = default(absPath(this.energySourceModule));
    gates:
        input upperLayerIn;
        output upperLayerOut;
        input radioIn @labels(IWirelessSignal);
    submodules:
        classifier: <default("OmittedIeee8021dQosClassifier")> like IIeee8021dQosClassifier {
            parameters:
                @display("p=200,100");
        }
        queue: <default("OmittedPacketQueue")> like IPacketQueue {
            parameters:
                @display("p=200,200;q=l2queue");
        }
        mac: <> like IMacProtocol {
            parameters:
                @display("p=300,200");
        }
        radio: <default("")> like IRadio if typename != "" {
            parameters:
                @display("p=300,300");
        }
    connections allowunconnected:
        upperLayerIn --> { @display("m=n"); } --> classifier.in;
        classifier.out --> queue.in;
        queue.out --> mac.upperLayerIn;
        mac.lowerLayerOut --> radio.upperLayerIn if exists(radio);

        radioIn --> { @display("m=s"); } --> radio.radioIn if exists(radio);
        radio.upperLayerOut --> mac.lowerLayerIn if exists(radio);
        mac.upperLayerOut --> { @display("m=n"); } --> upperLayerOut;
}

File: src/inet/linklayer/common/WirelessInterface.ned