EthernetSourceApp

Package: inet.applications.ethernet

compound module EthernetSourceApp

Implements an Ethernet application that only sends packets.

EthernetSourceAppsource.out --> tagger.in inherited from EthernetApp conditional: exists(source)?tagger.out --> measurementStarter.in inherited from EthernetAppmeasurementStarter.out --> io.trafficIn inherited from EthernetAppio.socketOut --> socketOut inherited from EthernetAppsocketIn --> io.socketIn inherited from EthernetAppio.trafficOut --> measurementRecorder.in inherited from EthernetAppmeasurementRecorder.out --> sink.in inherited from EthernetApp conditional: exists(sink)?source: inet.queueing.source.ActivePacketSource (like IActivePacketSource) inherited from EthernetApp ActivePacketSource: An active packet source which pushes packets into the connected module. IActivePacketSource: Interface for active packet source modules. Source: source: <default("ActivePacketSource")> like IActivePacketSource if typename != "" { parameters: @display("p=200,150"); }sourcetagger: inet.queueing.contract.IPacketFlow (like IPacketFlow) inherited from EthernetApp IPacketFlow: Interface for packet flows. Source: tagger: <default("")> like IPacketFlow { parameters: @display("p=200,300"); }taggermeasurementStarter: inet.queueing.contract.IPacketFlow (like IPacketFlow) inherited from EthernetApp IPacketFlow: Interface for packet flows. Source: measurementStarter: <default("")> like IPacketFlow { parameters: @display("p=200,450"); }measurementStartersink: inet.queueing.sink.PassivePacketSink (like IPassivePacketSink) inherited from EthernetApp PassivePacketSink: A passive packet sink which is pushed with packets by the connected packet producer. IPassivePacketSink: Interface for passive packet sink modules. Source: sink: <default("PassivePacketSink")> like IPassivePacketSink if typename != "" { parameters: @display("p=500,150"); }sinkmeasurementRecorder: inet.queueing.contract.IPacketFlow (like IPacketFlow) inherited from EthernetApp IPacketFlow: Interface for packet flows. Source: measurementRecorder: <default("")> like IPacketFlow { parameters: @display("p=500,450"); }measurementRecorderio: inet.applications.ethernet.EthernetSocketIo inherited from EthernetApp Provides Ethernet socket handling for generic applications. Source: io: EthernetSocketIo { parameters: @display("p=400,600"); }io

Inheritance diagram

Extends

Name

Type

Description

EthernetApp

compound module

Generates traffic as an Ethernet application. The traffic source and traffic sink modules can be built from queueing model elements.

Parameters

Name

Type

Default value

Description

interfaceTableModule

string

Relative module path of the interface table

Properties

Name

Value

Description

application

display

i=block/app

Gates

Name

Direction

Size

Description

socketIn

input

socketOut

output

Unassigned submodule parameters

Name

Type

Default value

Description

source.displayStringTextFormat

string

“created %p pk (%l)”

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

source.packetNameFormat

string

“%a-%c”

See directives in module documentation

source.packetRepresentation

string

“byteCount”

Determines the chunk of the packet data

source.packetProtocol

string

“unknown”

source.packetLength

int

source.packetData

int

-1

source.attachCreationTimeTag

bool

true

source.attachIdentityTag

bool

true

source.attachDirectionTag

bool

true

source.clockModule

string

“”

Relative path of a module that implements IClock(1,:ref:2 <neddoc-msg-inet-iclock>); optional

source.initialProductionOffset

double

-1s

Initial duration before which packets are not produced. When negative, then produce packet in initialize()

source.productionInterval

double

Elapsed time between subsequent packets pushed to the connected packet consumer

source.scheduleForAbsoluteTime

bool

true

When a clock is used, “relative” means that setting the clock will not affect the simulation time of the event

sink.displayStringTextFormat

string

“received %p pk (%l)”

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

sink.clockModule

string

“”

Relative path of a module that implements IClock(1,:ref:2 <neddoc-msg-inet-iclock>); optional

sink.initialConsumptionOffset

double

0s

Initial duration before which packets are not consumed

sink.consumptionInterval

double

0s

Elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time

sink.scheduleForAbsoluteTime

bool

true

When a clock is used, “relative” means that setting the clock will not affect the simulation time of the event

io.displayStringTextFormat

string

“rcvd: {numReceived} pks\nsent: {numSent} pks”

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

io.interfaceTableModule

string

Relative module path of the interface table

io.interface

string

“”

Network interface name

io.protocol

string

“”

Bind the socket to this protocol if specified

io.localAddress

string

“”

Local Ethernet MAC address

io.remoteAddress

string

“”

Remote Ethernet MAC address

io.steal

bool

false

Steal packets

io.stopOperationExtraTime

double

-1s

Extra time after lifecycle stop operation finished

io.stopOperationTimeout

double

2s

Timeout value for lifecycle stop operation

Source code

//
// Implements an Ethernet application that only sends packets.
//
module EthernetSourceApp extends EthernetApp
{
    parameters:
        sink.typename = "";
}

File: src/inet/applications/ethernet/EthernetSourceApp.ned