ShortcutInterface

Package: inet.linklayer.shortcut

ShortcutInterface

compound module

This module implements a simpistic network interface that uses a shortcut to the receiver at the MAC layer.

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: This module interface is implemented by clock models.

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

OmittedIeee8021dQosClassifier: This module implements the module given interface and can be used as an omitted optional module...

IIeee8021dQosClassifier: Interface for 802.1d QoS classifiers.

Source:
classifier: <default("OmittedIeee8021dQosClassifier")> like IIeee8021dQosClassifier {
    parameters:
        @display("p=200,100");
} queue : like IPacketQueue

OmittedPacketQueue: This module implements the module given interface and can be used as an omitted optional module...

IPacketQueue: This module interface is implemented by packet queue modules.

Source:
queue: <default("OmittedPacketQueue")> like IPacketQueue {
    parameters:
        @display("p=200,200;q=l2queue");
} mac : like IMacProtocol

IMacProtocol: This interface provides an abstraction for different MAC protocols.

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

IRadio: Module interface for radio modules.

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

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
WirelessInterface compound module

This module implements a generic wireless network interface.

Parameters

Name Type Default value Description
displayStringTextFormat string "%a (%i)\n%m"
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
interfaceTableModule string
energySourceModule string
protocol string ""

Properties

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

Gates

Name Direction Size Description
upperLayerIn input
upperLayerOut output
radioIn input

Signals

Name Type Unit
packetDropped inet::Packet

Statistics

Name Title Source Record Unit Interpolation Mode
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

Direct method calls (observed)

call tofunctioninfo
MessageDispatcherinet::MessageDispatcher::handleRegisterInterfacehandleRegisterInterface
InterfaceTableinet::InterfaceTable::findInterfaceByNamefindInterfaceByName
InterfaceTableinet::InterfaceTable::interfaceChangedinterfaceChanged

Called methods (observed)

functioninfocall from
inet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE-=Network=-, OmittedIeee8021dQosClassifier, OmittedPacketQueue

Tagging operations (observed)

tagTypetagAction
clearTags

Unassigned submodule parameters

Name Type Default value Description
pcapRecorder.verbose bool true

whether to log packets on the module output

pcapRecorder.pcapFile string ""

the PCAP file to be written

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

maximum number of bytes to record per packet

pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError

pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to

pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

pcapRecorder.displayStringTextFormat string "rec: %n pks"

Source code

//
// This module implements a simpistic 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