RtpHost

Package: inet.node.rtp

RtpHost

compound module

(no description)

NodeStatus IClock IEnergyStorage IEnergyManagement IEnergyGenerator IMobility IMeasurer PcapRecorder InterfaceTable IIeee8022Llc MessageDispatcher IProtocolLayer MessageDispatcher IEthernetLayer IIeee8021qLayer IIeee8021rLayer MessageDispatcher ILoopbackInterface IWirelessInterface IPppInterface IEthernetInterface ITunnelInterface IVirtualInterface INetworkLayer INetworkLayer INetworkLayer MessageDispatcher IUdp ITcp ISctp MessageDispatcher IApp MessageDispatcher RtpApplication Rtp Rtcp

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
StandardHost compound module

IPv4 host with SCTP, TCP, UDP layers and applications. IP forwarding is disabled by default (see forwarding).

Parameters

Name Type Default value Description
hasStatus bool false
osgModel string ""

3D model for OSG visualization, no 3D model by default
osgModelColor string ""

tint color, no colorization by default
canvasImage string ""

image for canvas visualization, no image by default
canvasImageColor string ""

tint color, no colorization by default
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
numLoInterfaces int 1
numWlanInterfaces int 0
numEthInterfaces int 0

minimum number of ethernet interfaces
numPppInterfaces int 0

minimum number of PPP interfaces
numTunInterfaces int 0
numVirtInterfaces int 0
fcsMode string "declared"
hasIpv4 bool true
hasIpv6 bool false
hasGn bool false
forwarding bool false
multicastForwarding bool false
hasUdp bool true
hasTcp bool firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc") != ""
hasSctp bool false
numApps int 0
profileName string
destinationAddress string
portNumber int
bandwidth double
fileName string
payloadType int

Properties

Name Value Description
networkNode
labels node
class NodeBase
display i=device/pc2

Gates

Name Direction Size Description
radioIn [ ] input numWlanInterfaces
pppg [ ] inout numPppInterfaces
ethg [ ] inout numEthInterfaces

Unassigned submodule parameters

Name Type Default value Description
status.initialStatus string "UP"

TODO @signal, @statistic
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.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
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"
interfaceTable.displayAddresses bool false

whether to display IP addresses on links
cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
cb.forwardServiceRegistration bool true
cb.forwardProtocolRegistration bool true
bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
bl.forwardServiceRegistration bool true
bl.forwardProtocolRegistration bool true
li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
li.forwardServiceRegistration bool true
li.forwardProtocolRegistration bool true
eth.bitrate double
nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
nl.forwardServiceRegistration bool true
nl.forwardProtocolRegistration bool true
tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
tn.forwardServiceRegistration bool true
tn.forwardProtocolRegistration bool true
at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
at.forwardServiceRegistration bool true
at.forwardProtocolRegistration bool true
rtpApp.commonName string

the common name (CNAME) of this host
rtpApp.sessionEnterDelay double

delay before starts a new session
rtpApp.transmissionStartDelay double

delay before start transmission (related to "sender module created")
rtpApp.transmissionStopDelay double

delay before stops transmission (related to "start transmission")
rtpApp.sessionLeaveDelay double

delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
rtp.interfaceTableModule string

The path to the InterfaceTable module
rtp.routingTableModule string
rtcp.interfaceTableModule string

The path to the InterfaceTable module

Source code

module RtpHost extends StandardHost
{
    parameters:
        string profileName;
        string destinationAddress;
        int portNumber;
        double bandwidth;
        string fileName;
        int payloadType;
        hasUdp = true;
        @display("i=device/pc2");

    submodules:
        rtpApp: RtpApplication {
            parameters:
                profileName = parent.profileName;
                destinationAddress = parent.destinationAddress;
                portNumber = parent.portNumber;
                bandwidth = parent.bandwidth;
                fileName = parent.fileName;
                payloadType = parent.payloadType;
                @display("p=825,76");
        }
        rtp: Rtp {
            parameters:
                @display("p=975,76");
        }
        rtcp: Rtcp {
            parameters:
                @display("p=1125,76");
        }

    connections allowunconnected:
        // transport connections
        rtpApp.rtpOut --> rtp.appIn;
        rtpApp.rtpIn <-- rtp.appOut;

        rtp.udpOut --> at.in++;
        rtp.udpIn <-- at.out++;

        rtcp.udpOut --> at.in++;
        rtcp.udpIn <-- at.out++;

        rtp.rtcpOut --> IdealChannel --> rtcp.rtpIn;
        rtcp.rtpOut --> IdealChannel --> rtp.rtcpIn;
}
File: src/inet/node/rtp/RtpHost.ned

This documentation is released under the Creative Commons license