ShortcutInterface¶

compound module ShortcutInterface

Implements a simplistic network interface that uses a shortcut to the receiver at the MAC layer.

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
mac.displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
mac.interfaceTableModule	string
mac.address	string	“auto”	MAC address as a hex string (12 hex digits), or
mac.bitrate	double		“auto”. “auto” values will be replaced by a generated MAC address in init stage 0.
mac.mtu	int	1500B
mac.lengthOverhead	int	0b	Extra length added to packets
mac.durationOverhead	double	0s	Extra transmission duration added to packets
mac.propagationDelay	double	0s	Propagation time to all destinations
mac.packetLoss	double	0	Packet loss probability

Source code¶

//
// Implements a simplistic network interface that uses a shortcut to
// the receiver at the MAC layer.
//
module ShortcutInterface extends WirelessInterface
{
    parameters:
        radio.typename = "";
        mac.typename = "ShortcutMac";
        queue.typename = "OmittedPacketQueue";
}

File: src/inet/linklayer/shortcut/ShortcutInterface.ned