Package: inet.emulation.linklayer.ethernet

ExtLowerEthernetInterface

compound module

Provides an Ethernet network interface suitable for emulation. The lower part of the network interface is realized in the real world using a real Ethernet socket of the host computer which is running the simulation.

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.

Extends

Name	Type	Description
ExtInterface	compound module	A base for external network interfaces, network interface modules that connect the simulation to the network stack of the host OS.

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
isWireless	bool	false
interfaceTableModule	string		Module path of the interface table module
device	string		Name of the attached OS device (e.g. tap0, veth0, etc.)
namespace	string	""	Name of the OS network namespace (optional)
copyConfiguration	string	""	Copy interface configuration such as MAC address, IP address, and MTU from/to the external interface.
address	string	"auto"
broadcast	bool	true
multicast	bool	true
pointToPoint	bool	false
mtu	int	4470B
protocol	string	"ethernetmac"
bitrate	double	nan bps

Properties

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

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 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
socket.displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
socket.device	string		Name of an existing real Ethernet device
socket.namespace	string	""
socket.packetNameFormat	string	"Ext-%p-%t-%n"	Name of received packets

Source code

//
// Provides an Ethernet network interface suitable for emulation.
// The lower part of the network interface is realized in the real world using
// a real Ethernet socket of the host computer which is running the simulation.
//
module ExtLowerEthernetInterface extends ExtInterface like IEthernetInterface
{
    parameters:
        string protocol = default("ethernetmac");
        double bitrate @unit(bps) = default(nan bps);
    gates:
        input cutthroughIn @loose;
        output cutthroughOut @loose;
        inout phys @loose;
    submodules:
        socket: ExtEthernetSocket {
            parameters:
                @display("p=300,200");
        }
    connections allowunconnected:
        upperLayerIn --> { @display("m=n"); } --> socket.upperLayerIn;
        upperLayerOut <-- { @display("m=n"); } <-- socket.upperLayerOut;
}

File: src/inet/emulation/linklayer/ethernet/ExtLowerEthernetInterface.ned