NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ns3::OnOffApplication Class Reference

#include <introspected-doxygen.hpp>

Detailed Description

Config Paths

ns3::OnOffApplication is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication"

Attributes

  • DataRate: The data rate in on state.
    • Set with class: DataRateValue
    • Underlying type: DataRate
    • Initial value: 500000bps
    • Flags: construct write read
  • PacketSize: The size of packets sent in on state
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 1:4294967295
    • Initial value: 512
    • Flags: construct write read
  • Remote: The address of the destination
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • Local: The Address on which to bind the socket. If not set, it is generated automatically.
    • Set with class: AddressValue
    • Underlying type: Address
    • Initial value: 00-00-00
    • Flags: construct write read
  • OnTime: A RandomVariableStream used to pick the duration of the 'On' state.
  • OffTime: A RandomVariableStream used to pick the duration of the 'Off' state.
  • MaxBytes: The total number of bytes to send. Once these bytes are sent, no packet is sent again, even in on state. The value zero means that there is no limit.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint64_t 0:18446744073709551615
    • Initial value: 0
    • Flags: construct write read
  • Protocol: The type of protocol to use. This should be a subclass of ns3::SocketFactory
    • Set with class: TypeIdValue
    • Underlying type: TypeId
    • Initial value: ns3::UdpSocketFactory
    • Flags: construct write read
  • EnableSeqTsSizeHeader: Enable use of SeqTsSizeHeader for sequence number and timestamp
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

Attributes defined in parent class ns3::Application

  • StartTime: Time at which the application will start
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read

TraceSources

  • Tx: A new packet is created and is sent
    Callback signature: ns3::Packet::TracedCallback
  • TxWithAddresses: A new packet is created and is sent
    Callback signature: ns3::Packet::TwoAddressTracedCallback
  • TxWithSeqTsSize: A new packet is created with SeqTsSizeHeader
    Callback signature: ns3::PacketSink::SeqTsSizeCallback

Size of this type is 368 bytes (on a 64-bit architecture).


The documentation for this class was generated from the following file: