Package: inet.linklayer.tun
TunInterface
compound moduleThis module implements a TUN 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.
Extends
Name | Type | Description |
---|---|---|
NetworkInterface | compound module |
This module serves as the base module for all network interfaces. |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
displayStringTextFormat | string | "%a (%i)\n%m" | |
recordPcap | bool | false | |
numPcapRecorders | int | recordPcap ? 1 : 0 | |
isWireless | bool | false | |
interfaceTableModule | string | ||
mtu | int | 1500B |
Properties
Name | Value | Description |
---|---|---|
networkInterface | ||
lifecycleSupport | ||
class | NetworkInterface | |
display | i=block/tunnel |
Gates
Name | Direction | Size | Description |
---|---|---|---|
upperLayerIn | input | ||
upperLayerOut | output |
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 |
InterfaceTable | inet::InterfaceTable::findInterfaceByName | findInterfaceByName |
InterfaceTable | inet::InterfaceTable::interfaceChanged | interfaceChanged |
Called methods (observed)
function | info | call from |
---|---|---|
inet::NetworkInterface::receiveSignal | POST_MODEL_CHANGE | -=Network=- |
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" | |
tun.interfaceTableModule | string |
The path to the InterfaceTable module |
|
tun.mtu | int | 1500B |
Source code
// // This module implements a TUN network interface. // module TunInterface extends NetworkInterface like ITunnelInterface { parameters: bool isWireless = default(false); string interfaceTableModule; int mtu @unit(B) = default(1500B); *.interfaceTableModule = default(absPath(this.interfaceTableModule)); @display("i=block/tunnel"); gates: input upperLayerIn; output upperLayerOut; submodules: tun: Tun { parameters: @display("p=300,100"); } connections: upperLayerIn --> { @display("m=n"); } --> tun.upperLayerIn; tun.upperLayerOut --> { @display("m=n"); } --> upperLayerOut; }File: src/inet/linklayer/tun/TunInterface.ned