Package: inet.linklayer.ethernet

LayeredEthernetInterface

compound module

This module implements an Ethernet network interface.

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

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

Known subclasses

Name	Type	Description
EthernetCutthroughInterface	compound module	This module represents an Ethernet network interface with cut-through support.

Extends

Name	Type	Description
NetworkInterface	compound module	This module serves as the base module for all network interfaces.

Parameters

Name	Type	Default value
displayStringTextFormat	string	"%a (%i)\n%m"
recordPcap	bool	false
numPcapRecorders	int	recordPcap ? 1 : 0
protocol	string	"ethernetmac"
broadcast	bool	true
multicast	bool	true
address	string	"auto"
bitrate	double
mtu	int	1500B
interfaceTableModule	string

Properties

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

Gates

Name	Direction	Size	Description
upperLayerIn	input
upperLayerOut	output
cutthroughIn	input
cutthroughOut	output
phys	inout

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 to	function	info
MessageDispatcher	inet::MessageDispatcher::handleRegisterInterface	handleRegisterInterface
MessageDispatcher	inet::MessageDispatcher::pushPacket	pushPacket
L2NodeConfigurator	inet::L2NodeConfigurator::receiveSignal	interfaceCreated
LayeredEthernetInterface	inet::NetworkInterface::receiveSignal	POST_MODEL_CHANGE
Ieee8021qTimeAwareShaper	inet::queueing::CompoundPacketQueueBase::pushPacket	pushPacket
InterfaceTable	inet::InterfaceTable::findInterfaceByName	findInterfaceByName
InterfaceTable	inet::InterfaceTable::interfaceChanged	interfaceChanged
PacketClassifier	inet::queueing::PacketClassifier::pushPacket	pushPacket
FlowMeasurementStarter	inet::queueing::FlowMeasurementStarter::pushPacket	pushPacket
DropTailQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
GatingPriorityQueue	inet::queueing::CompoundPacketQueueBase::pushPacket	pushPacket
PacketQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
PriorityQueue	inet::queueing::CompoundPacketQueueBase::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::NetworkInterface::handleOperationStage	handleOperationStage	ScenarioManager
inet::NetworkInterface::pushPacket	pushPacket	MessageDispatcher, EthernetFcsChecker, PacketMultiplexer, FlowMeasurementRecorder
inet::NetworkInterface::receiveSignal	POST_MODEL_CHANGE	-=Network=-, ScenarioManager, EagerGateScheduleConfigurator, Z3GateScheduleConfigurator, LayeredEthernetInterface, Ieee8021qAsynchronousShaper, Ieee8021qCreditBasedShaper, OmittedMeasurementLayer, OmittedProcessingDelayLayer, OmittedTrafficConditionerLayer, OmittedPacketFlow, OmittedPacketGate, PeriodicGate, OmittedPacketQueue

Push out messages (observed)

gate	msg	destModule	tags
upperLayerIn	Packet	PcpTrafficClassClassifier	DirectionTag, EncapsulationProtocolReq, InterfaceInd, InterfaceReq, MacAddressReq, PacketProtocolTag, DropEligibleInd?, DropEligibleReq?, EligibilityTimeTag?, PcpInd?, PcpReq?, StreamReq?, UserPriorityInd?, UserPriorityReq?, VlanInd?, VlanReq?
upperLayerIn	Packet	ContentBasedClassifier	DirectionTag, InterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, DropEligibleInd?, EncapsulationProtocolReq?, InterfaceInd?, MulticastReq?, NetworkProtocolInd?, PcpInd?, SequenceNumberInd?, StreamReq?, TransportProtocolInd?, UserPriorityInd?, VlanInd?
upperLayerIn	Packet	PacketClassifier	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
upperLayerIn	Packet	FlowMeasurementStarter	DirectionTag, InterfaceReq, MacAddressReq, PacketProtocolTag
upperLayerIn	Packet	DropTailQueue	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
upperLayerIn	Packet	PacketQueue	InterfaceReq, MacAddressReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, DropEligibleInd?, DropEligibleReq?, EcnInd?, EncapsulationProtocolReq?, Ieee802SapReq?, InterfaceInd?, MulticastReq?, NetworkProtocolInd?, PcpInd?, PcpReq?, SequenceNumberInd?, SocketReq?, StreamReq?, TransportProtocolInd?, UserPriorityInd?, UserPriorityReq?, VlanInd?, VlanReq?
upperLayerOut	Packet	MessageDispatcher	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag, FragmentTag?, GptpIngressTimeInd?

Shared Tagging operations (observed)

tagType	tagAction
InterfaceInd	addTagIfAbsent

Tagging operations (observed)

tagType	tagAction
	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 an Ethernet network interface.
//
module LayeredEthernetInterface extends NetworkInterface like IEthernetInterface
{
    parameters:
        string protocol = default("ethernetmac");
        bool broadcast = default(true);
        bool multicast = default(true);
        string address @mutable = default("auto");
        double bitrate @unit(bps);
        int mtu @unit(B) = default(1500B);
        string interfaceTableModule;
        *.bitrate = default(this.bitrate);
    gates:
        input upperLayerIn;
        output upperLayerOut;
        input cutthroughIn @loose;
        output cutthroughOut @loose;
        inout phys @labels(EthernetSignal);
    submodules:
        processingDelayLayer: <default("")> like IProcessingDelayLayer {
            parameters:
                @display("p=400,100");
        }
        trafficConditionerLayer: <default("")> like ITrafficConditionerLayer {
            parameters:
                @display("p=400,200");
        }
        measurementLayer: <default("")> like IMeasurementLayer {
            parameters:
                @display("p=400,300");
        }
        macLayer: <default("EthernetMacLayer")> like IEthernetMacLayer {
            parameters:
                @display("p=400,400");
        }
        phyLayer: <default("EthernetPhyLayer")> like IEthernetPhyLayer {
            parameters:
                transmitter.clockModule = default("");
                @display("p=400,500");
        }
    connections allowunconnected:
        upperLayerIn --> { @display("m=n"); } --> processingDelayLayer.upperLayerIn;
        processingDelayLayer.lowerLayerOut --> trafficConditionerLayer.upperLayerIn;
        trafficConditionerLayer.lowerLayerOut --> measurementLayer.upperLayerIn;
        measurementLayer.lowerLayerOut --> macLayer.upperLayerIn;
        macLayer.lowerLayerOut --> phyLayer.upperLayerIn;
        phyLayer.lowerLayerOut --> { @display("m=s"); } --> phys$o;

        phys$i --> { @display("m=s"); } --> phyLayer.lowerLayerIn;
        phyLayer.upperLayerOut --> macLayer.lowerLayerIn;
        macLayer.upperLayerOut --> measurementLayer.lowerLayerIn;
        measurementLayer.upperLayerOut --> trafficConditionerLayer.lowerLayerIn;
        trafficConditionerLayer.upperLayerOut --> processingDelayLayer.lowerLayerIn;
        processingDelayLayer.upperLayerOut --> { @display("m=n"); } --> upperLayerOut;
}

File: src/inet/linklayer/ethernet/LayeredEthernetInterface.ned