NED File src/inet/applications/udpapp/UdpBasicApp.ned
Name | Type | Description |
---|---|---|
UdpBasicApp | simple module |
Sends UDP packets to the given IP address at the given interval. Compatible with both Ipv4 and Ipv6. |
Source code
// // Copyright (C) 2004 OpenSim Ltd. // // SPDX-License-Identifier: LGPL-3.0-or-later // package inet.applications.udpapp; import inet.applications.contract.IApp; // // Sends UDP packets to the given IP address at the given interval. // Compatible with both ~Ipv4 and ~Ipv6. // // The sending interval can be a constant or a random value (e.g. exponential(1)). // If the destAddresses parameter contains more than one address, one // of them is randomly chosen for each packet. An address may be given in the // dotted decimal notation, or with the module name. (The L3AddressResolver // class is used to resolve the address.) To disable the model, set // destAddresses to "". // // Received packets are discarded. // // The peer can be a ~UdpSink, another ~UdpBasicApp (it handles received packets // like ~UdpSink), or a ~UdpEchoApp. When used with ~UdpEchoApp, the rcvdPkLifetime // statistic will contain the round-trip times. // simple UdpBasicApp like IApp { parameters: string interfaceTableModule; // The path to the InterfaceTable module string clockModule = default(""); // relative path of a module that implements IClock; optional int localPort = default(-1); // local port (-1: use ephemeral port) string destAddresses = default(""); // list of IP addresses, separated by spaces ("": don't send) string localAddress = default(""); string packetName = default("UdpBasicAppData"); int destPort; volatile int messageLength @unit(B); // length of messages to generate, in bytes double startTime @unit(s) = default(this.sendInterval); // application start time (start of the first packet) double stopTime @unit(s) = default(-1s); // time of finishing sending, -1s means forever volatile double sendInterval @unit(s); // should usually be a random value, e.g. exponential(1) int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value bool dontFragment = default(false); // if true, asks IP to not fragment the message during routing int dscp = default(-1); // if not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value string multicastInterface = default(""); // if not empty, set the multicast output interface option on the socket (interface name expected) bool receiveBroadcast = default(false); // if true, makes the socket receive broadcast packets bool joinLocalMulticastGroups = default(false); // if true, makes the socket receive packets from all multicast groups set on local interfaces @display("i=block/app"); @lifecycleSupport; double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[throughput](title="throughput"; unit=bps; source="throughput(packetReceived)"; record=vector); @statistic[packetSent](title="packets sent"; source=packetSent; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[rcvdPkLifetime](title="received packet lifetime"; source="dataAge(packetReceived)"; unit=s; record=stats,vector; interpolationmode=none); @statistic[rcvdPkSeqNo](title="received packet sequence number"; source="appPkSeqNo(packetReceived)"; record=vector; interpolationmode=none); gates: input socketIn @labels(UdpControlInfo/up); output socketOut @labels(UdpControlInfo/down); }