UdpSinkApp

Package: inet.applications.udpapp

UdpSinkApp

compound module

This module implements a UDP application that only receives packets.

source : like IActivePacketSource

ActivePacketSource: This module is an active packet source which pushes packets into the connected module.

IActivePacketSource: This module interface must be implemented by active packet source modules.

Source:
source: <default("ActivePacketSource")> like IActivePacketSource if typename != "" {
    parameters:
        @display("p=200,150");
} tagger : like IPacketFlow

IPacketFlow: This module interface is implemented by packet flows.

Source:
tagger: <default("")> like IPacketFlow {
    parameters:
        @display("p=200,300");
} measurementStarter : like IPacketFlow

IPacketFlow: This module interface is implemented by packet flows.

Source:
measurementStarter: <default("")> like IPacketFlow {
    parameters:
        @display("p=200,450");
} sink : like IPassivePacketSink

PassivePacketSink: This module is a passive packet sink which is pushed with packets by the connected packet producer.

IPassivePacketSink: This module interface must be implemented by passive packet sink modules.

Source:
sink: <default("PassivePacketSink")> like IPassivePacketSink if typename != "" {
    parameters:
        @display("p=500,150");
} measurementRecorder : like IPacketFlow

IPacketFlow: This module interface is implemented by packet flows.

Source:
measurementRecorder: <default("")> like IPacketFlow {
    parameters:
        @display("p=500,450");
} io : UdpSocketIo

This module provides UDP socket handling for generic applications.

Source:
io: UdpSocketIo {
    parameters:
        @display("p=350,600");
}

Inheritance diagram

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

Extends

Name Type Description
UdpApp compound module

This module generates traffic for a UDP application. The traffic source and traffic sink modules can be built from queueing model elements.

Parameters

Name Type Default value Description
interfaceTableModule string

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
io.interfaceTableModule string
io.localAddress string ""
io.localPort int -1
io.destAddress string ""
io.destPort int
io.timeToLive int -1

if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value

io.dontFragment bool false

if true, asks IP to not fragment the message during routing

io.dscp int -1

if not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value

io.tos int -1

if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value

io.multicastInterface string ""

if not empty, set the multicast output interface option on the socket (interface name expected)

io.multicastAddresses object []

list of multicast addresses that the application socket joins

io.receiveBroadcast bool false

if true, makes the socket receive broadcast packets

io.joinLocalMulticastGroups bool false

if true, makes the socket receive packets from all multicast groups set on local interfaces

io.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished

io.stopOperationTimeout double 2s

timeout value for lifecycle stop operation

Source code

//
// This module implements a UDP application that only receives packets.
//
module UdpSinkApp extends UdpApp
{
    parameters:
        source.typename = "";
        io.destPort = -1;
}
File: src/inet/applications/udpapp/UdpSinkApp.ned