EthernetInterface

Package: inet.linklayer.ethernet.basic

compound module EthernetInterface

Represents an Ethernet network interface.

EthernetInterfaceupperLayerIn --> egressTC.inegressTC.out --> queue.inqueue.out --> mac.upperLayerInmac.phys <--> physmac.upperLayerOut --> ingressTC.iningressTC.out --> upperLayerOutpcapRecorder[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"); }clockegressTC: inet.queueing.contract.ITrafficConditioner (like ITrafficConditioner) ITrafficConditioner: Interface for traffic conditioner modules. Source: egressTC: <default("")> like ITrafficConditioner { parameters: @display("p=300,100"); }egressTCingressTC: inet.queueing.contract.ITrafficConditioner (like ITrafficConditioner) ITrafficConditioner: Interface for traffic conditioner modules. Source: ingressTC: <default("")> like ITrafficConditioner { parameters: @display("i=block/uparrow;p=700,100"); }ingressTCqueue: inet.linklayer.ethernet.common.EthernetQueue (like IPacketQueue) EthernetQueue: Queue module that gives the PAUSE frames a higher priority. IPacketQueue: Interface for packet queue modules. Source: queue: <default("EthernetQueue")> like IPacketQueue { parameters: packetCapacity = default(1000); @display("p=300,250"); }queuemac: inet.linklayer.ethernet.basic.EthernetCsmaMacPhy (like IEtherMac) EthernetCsmaMacPhy: Ethernet MAC layer. IEtherMac: Interface for Ethernet MAC implementations. Source: mac: <default(csmacdSupport ? "EthernetCsmaMacPhy" : "EthernetMacPhy")> like IEtherMac { parameters: @display("p=500,300"); }mac

Usage diagram

Inheritance diagram

Used in compound modules

Name

Type

Description

LinkLayerNodeBase

compound module

An extension of the basic node infrastructure with link layer functionality. Provides support for various network interfaces and link layer protocols, forming the foundation for network connectivity.

EthernetHost

compound module

A simplified network device that communicates directly over Ethernet without higher layer protocols like IP or TCP. It provides a basic host model for Ethernet-only simulations.

AccessPoint

compound module

A wireless access point device that connects wireless stations (like WirelessHost) to a wired network. Supports multiple wireless radios and multiple Ethernet ports.

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

protocol

string

“ethernetmac”

address

string

“auto”

MAC address as a hex string (12 hex digits), or

duplexMode

bool

true

Selects full-duplex (true) or half-duplex (false) operation

csmacdSupport

bool

!duplexMode

By default, CSMA/CD is turned off, so only point-to-point duplex links are supported.

bitrate

double

0 bps

fcsMode

string

“declared”

Properties

Name

Value

Description

class

NetworkInterface

display

i=block/ifcard

lifecycleSupport

networkInterface

Gates

Name

Direction

Size

Description

upperLayerIn

input

upperLayerOut

output

cutthroughIn

input

cutthroughOut

output

phys

inout

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

//
// Represents an Ethernet network interface.
//
module EthernetInterface extends NetworkInterface like IEthernetInterface
{
    parameters:
        string interfaceTableModule;
        string protocol = default("ethernetmac");
        string address @mutable = default("auto");   // MAC address as a hex string (12 hex digits), or
                                                     // "auto". "auto" values will be replaced by
                                                     // a generated MAC address in init stage 0.
        bool duplexMode = default(true);      // Selects full-duplex (true) or half-duplex (false) operation
        bool csmacdSupport = default(!duplexMode);  // By default, CSMA/CD is turned off, so only point-to-point duplex links are supported.
        double bitrate @unit(bps) = default(0 bps);
        string fcsMode @enum("declared","computed") = default("declared");
        *.interfaceTableModule = default(absPath(this.interfaceTableModule));
        *.fcsMode = this.fcsMode;
        *.duplexMode = this.duplexMode;
    gates:
        input upperLayerIn;
        output upperLayerOut;
        input cutthroughIn @loose;
        output cutthroughOut @loose;
        inout phys @labels(EthernetSignal);
    submodules:
        egressTC: <default("")> like ITrafficConditioner {
            parameters:
                @display("p=300,100");
        }
        ingressTC: <default("")> like ITrafficConditioner {
            parameters:
                @display("i=block/uparrow;p=700,100");
        }
        queue: <default("EthernetQueue")> like IPacketQueue {
            parameters:
                packetCapacity = default(1000);
                @display("p=300,250");
        }
        mac: <default(csmacdSupport ? "EthernetCsmaMacPhy" : "EthernetMacPhy")> like IEtherMac {
            parameters:
                @display("p=500,300");
        }
    connections:
        upperLayerIn --> { @display("m=n"); } --> egressTC.in;
        egressTC.out --> queue.in;
        queue.out --> mac.upperLayerIn;

        mac.phys <--> { @display("m=s"); } <--> phys;

        mac.upperLayerOut --> ingressTC.in;
        ingressTC.out --> { @display("m=n"); } --> upperLayerOut;
}

File: src/inet/linklayer/ethernet/basic/EthernetInterface.ned