A Discrete-Event Network Simulator
API
All TraceSources

This is a list of all Tracing sources.

For more information see the Tracing section of this API documentation and the Tracing sections in the Tutorial and Manual.

ns3::BooleanProbe

  • Output: The bool that serves as output for this probe

ns3::DoubleProbe

  • Output: The double that serves as output for this probe

ns3::TimeProbe

  • Output: The double valued (units of seconds) probe output

ns3::Uinteger8Probe

  • Output: The uint8_t that serves as output for this probe

ns3::Uinteger16Probe

  • Output: The uint16_t that serves as output for this probe

ns3::Uinteger32Probe

  • Output: The uint32_t that serves as output for this probe

ns3::TimeSeriesAdaptor

  • Output: The current simulation time versus the current value converted to a double

ns3::Queue

  • Enqueue: Enqueue a packet in the queue.
  • Dequeue: Dequeue a packet from the queue.
  • Drop: Drop a packet (for whatever reason).
  • PacketsInQueue: Number of packets currently stored in the queue
  • BytesInQueue: Number of bytes currently stored in the queue

ns3::DynamicQueueLimits

  • Limit: Limit value calculated by DQL

ns3::PacketSocket

  • Drop: Drop packet due to receive buffer overflow

ns3::SimpleNetDevice

  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception

ns3::PacketSocketClient

  • Tx: A packet has been sent

ns3::PacketSocketServer

  • Rx: A packet has been received

ns3::PacketProbe

  • Output: The packet that serve as the output for this probe
  • OutputBytes: The number of bytes in the packet

ns3::VirtualNetDevice

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

ns3::FdNetDevice

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

ns3::CsmaNetDevice

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • MacTxBackoff: Trace source indicating a packet has been delayed by the CSMA backoff process
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxEnd: Trace source indicating a packet has been completely received by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

ns3::BasicEnergySource

  • RemainingEnergy: Remaining energy at BasicEnergySource.

ns3::LiIonEnergySource

  • RemainingEnergy: Remaining energy at BasicEnergySource.

ns3::RvBatteryModel

  • RvBatteryModelBatteryLevel: RV battery model battery level.
  • RvBatteryModelBatteryLifetime: RV battery model battery lifetime.

ns3::SimpleDeviceEnergyModel

  • TotalEnergyConsumption: Total energy consumption of the radio device.

ns3::BasicEnergyHarvester

  • HarvestedPower: Harvested power by the BasicEnergyHarvester.
  • TotalEnergyHarvested: Total energy harvested by the harvester.

ns3::MobilityModel

  • CourseChange: The value of the position and/or velocity vector changed

ns3::UanPhyGen

  • RxOk: A packet was received successfully.
  • RxError: A packet was received unsuccessfully.
  • Tx: Packet transmission beginning.

ns3::UanPhy

  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium.
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel.
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission.
  • PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device.
  • PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device.
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception.

ns3::UanNetDevice

  • Rx: Received payload from the MAC layer.
  • Tx: Send payload to the MAC layer.

ns3::UanMacCw

  • Enqueue: A packet arrived at the MAC for transmission.
  • Dequeue: A was passed down to the PHY from the MAC.
  • RX: A packet was destined for this MAC and was received.

ns3::UanPhyDual

  • RxOk: A packet was received successfully.
  • RxError: A packet was received unsuccessfully.
  • Tx: Packet transmission beginning.

ns3::UanMacRc

  • Enqueue: A (data) packet arrived at MAC for transmission.
  • Dequeue: A (data) packet was passed down to PHY from MAC.
  • RX: A packet was destined for and received at this MAC layer.

ns3::UanMacRcGw

  • RX: A packet was destined for and received at this MAC layer.
  • Cycle: Trace cycle statistics.

ns3::AcousticModemEnergyModel

  • TotalEnergyConsumption: Total energy consumption of the modem device.

ns3::QueueDisc

  • Enqueue: Enqueue a packet in the queue disc
  • Dequeue: Dequeue a packet from the queue disc
  • Requeue: Requeue a packet in the queue disc
  • Drop: Drop a packet stored in the queue disc
  • PacketsInQueue: Number of packets currently stored in the queue disc
  • BytesInQueue: Number of bytes currently stored in the queue disc

ns3::CoDelQueueDisc

  • Count: CoDel count
  • DropCount: CoDel drop count
  • LastCount: CoDel lastcount
  • DropState: Dropping state
  • Sojourn: Time in the queue
  • DropNext: Time until next packet drop

ns3::PointToPointNetDevice

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxEnd: Trace source indicating a packet has been completely received by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

ns3::PointToPointChannel

  • TxRxPointToPoint: Trace source indicating transmission of packet from the PointToPointChannel, used by the Animation interface.

ns3::Ipv4L3Protocol

  • Tx: Send ipv4 packet to outgoing interface.
  • Rx: Receive ipv4 packet from incoming interface.
  • Drop: Drop ipv4 packet
  • SendOutgoing: A newly-generated packet by this node is about to be queued for transmission
  • UnicastForward: A unicast IPv4 packet was received by this node and is being forwarded to another node
  • LocalDeliver: An IPv4 packet was received by/for this node, and it is being forward up the stack

ns3::ArpCache

  • Drop: Packet dropped due to ArpCache entry in WaitReply expiring.

ns3::ArpL3Protocol

  • Drop: Packet dropped because not enough room in pending queue for a specific cache entry.

ns3::UdpSocketImpl

  • Drop: Drop UDP packet due to receive buffer overflow

ns3::Ipv6L3Protocol

  • Tx: Send IPv6 packet to outgoing interface.
  • Rx: Receive IPv6 packet from incoming interface.
  • Drop: Drop IPv6 packet
  • SendOutgoing: A newly-generated packet by this node is about to be queued for transmission
  • UnicastForward: A unicast IPv6 packet was received by this node and is being forwarded to another node
  • LocalDeliver: An IPv6 packet was received by/for this node, and it is being forward up the stack

ns3::TcpSocketBase

  • RTO: Retransmission timeout
  • RTT: Last RTT sample
  • NextTxSequence: Next sequence number to send (SND.NXT)
  • HighestSequence: Highest sequence number ever sent in socket's life time
  • State: TCP state
  • CongState: TCP Congestion machine state
  • RWND: Remote side's flow control window
  • BytesInFlight: Socket estimation of bytes in flight
  • HighestRxSequence: Highest sequence number received from peer
  • HighestRxAck: Highest ack received from peer
  • CongestionWindow: The TCP connection's congestion window
  • SlowStartThreshold: TCP slow start threshold (bytes)
  • Tx: Send tcp packet to IP protocol
  • Rx: Receive tcp packet from IP protocol

ns3::TcpHybla

  • Rho: Rho parameter of Hybla

ns3::TcpWestwood

  • EstimatedBW: The estimated bandwidth

ns3::TcpRxBuffer

  • NextRxSequence: Next sequence number expected (RCV.NXT)

ns3::TcpTxBuffer

  • UnackSequence: First unacknowledged sequence number (SND.UNA)

ns3::Ipv4PacketProbe

  • Output: The packet plus its IPv4 object and interface that serve as the output for this probe
  • OutputBytes: The number of bytes in the packet

ns3::Ipv6PacketProbe

  • Output: The packet plus its IPv6 object and interface that serve as the output for this probe
  • OutputBytes: The number of bytes in the packet

ns3::SixLowPanNetDevice

  • Tx: Send - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
  • Rx: Receive - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
  • Drop: Drop - DropReason, packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.

ns3::olsr::RoutingProtocol

  • Rx: Receive OLSR packet.
  • Tx: Send OLSR packet.
  • RoutingTableChanged: The OLSR routing table has changed.

ns3::WimaxNetDevice

  • Rx: Receive trace
  • Tx: Transmit trace

ns3::BaseStationNetDevice

  • BSTx: A packet has been received from higher layers and is being processed in preparation for queueing for transmission.
  • BSTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
  • BSPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • BSRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • BSRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.

ns3::SubscriberStationNetDevice

  • SSTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
  • SSPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • SSRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • SSRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.

ns3::SimpleOfdmWimaxPhy

  • Rx: Receive trace
  • Tx: Transmit trace
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device
  • PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception

ns3::WimaxMacQueue

  • Enqueue: Enqueue trace
  • Dequeue: Dequeue trace
  • Drop: Drop trace

ns3::V4Ping

  • Rtt: The rtt calculated by the ping.

ns3::BulkSendApplication

  • Tx: A new packet is created and is sent

ns3::OnOffApplication

  • Tx: A new packet is created and is sent

ns3::PacketSink

  • Rx: A packet has been received

ns3::UdpEchoClient

  • Tx: A new packet is created and is sent

ns3::ApplicationPacketProbe

  • Output: The packet plus its socket address that serve as the output for this probe
  • OutputBytes: The number of bytes in the packet

ns3::SingleModelSpectrumChannel

  • PathLoss: This trace is fired whenever a new path loss value is calculated. The first and second parameters to the trace are pointers respectively to the TX and RX SpectrumPhy instances, whereas the third parameters is the loss value in dB. Note that the loss value reported by this trace is the single-frequency loss value obtained by evaluating only the TX and RX AntennaModels and the PropagationLossModel. In particular, note that SpectrumPropagationLossModel (even if present) is never used to evaluate the loss value reported in this trace.

ns3::MultiModelSpectrumChannel

  • PathLoss: This trace is fired whenever a new path loss value is calculated. The first and second parameters to the trace are pointers respectively to the TX and RX SpectrumPhy instances, whereas the third parameters is the loss value in dB. Note that the loss value reported by this trace is the single-frequency loss value obtained by evaluating only the TX and RX AntennaModels and the PropagationLossModel. In particular, note that SpectrumPropagationLossModel (even if present) is never used to evaluate the loss value reported in this trace.

ns3::WaveformGenerator

  • TxStart: Trace fired when a new transmission is started
  • TxEnd: Trace fired when a previosuly started transmission is finished

ns3::SpectrumAnalyzer

  • AveragePowerSpectralDensityReport: Trace fired whenever a new value for the average Power Spectral Density is calculated

ns3::AlohaNoackNetDevice

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,

ns3::HalfDuplexIdealPhy

  • TxStart: Trace fired when a new transmission is started
  • TxEnd: Trace fired when a previosuly started transmission is finished
  • RxStart: Trace fired when the start of a signal is detected
  • RxAbort: Trace fired when a previously started RX is aborted before time
  • RxEndOk: Trace fired when a previosuly started RX terminates successfully
  • RxEndError: Trace fired when a previosuly started RX terminates with an error (packet is corrupted)

ns3::LteSpectrumPhy

  • TxStart: Trace fired when a new transmission is started
  • TxEnd: Trace fired when a previosuly started transmission is finished
  • RxStart: Trace fired when the start of a signal is detected
  • RxEndOk: Trace fired when a previosuly started RX terminates successfully
  • RxEndError: Trace fired when a previosuly started RX terminates with an error
  • DlPhyReception: DL reception PHY layer statistics.
  • UlPhyReception: DL reception PHY layer statistics.

ns3::LteEnbPhy

  • ReportUeSinr: Report UEs' averaged linear SINR
  • ReportInterference: Report linear interference power per PHY RB
  • DlPhyTransmission: DL transmission PHY layer statistics.

ns3::LteUePhy

  • ReportCurrentCellRsrpSinr: RSRP and SINR statistics.
  • UlPhyTransmission: DL transmission PHY layer statistics.
  • ReportUeMeasurements: Report UE measurements RSRP (dBm) and RSRQ (dB).
  • StateTransition: Trace fired upon every UE PHY state transition

ns3::UeManager

  • StateTransition: fired upon every UE state transition seen by the UeManager at the eNB RRC

ns3::LteEnbRrc

  • NewUeContext: Fired upon creation of a new UE context.
  • ConnectionEstablished: Fired upon successful RRC connection establishment.
  • ConnectionReconfiguration: trace fired upon RRC connection reconfiguration
  • HandoverStart: trace fired upon start of a handover procedure
  • HandoverEndOk: trace fired upon successful termination of a handover procedure
  • RecvMeasurementReport: trace fired when measurement report is received

ns3::LteUeRrc

  • MibReceived: trace fired upon reception of Master Information Block
  • Sib1Received: trace fired upon reception of System Information Block Type 1
  • Sib2Received: trace fired upon reception of System Information Block Type 2
  • StateTransition: trace fired upon every UE RRC state transition
  • InitialCellSelectionEndOk: trace fired upon successful initial cell selection procedure
  • InitialCellSelectionEndError: trace fired upon failed initial cell selection procedure
  • RandomAccessSuccessful: trace fired upon successful completion of the random access procedure
  • RandomAccessError: trace fired upon failure of the random access procedure
  • ConnectionEstablished: trace fired upon successful RRC connection establishment
  • ConnectionTimeout: trace fired upon timeout RRC connection establishment because of T300
  • ConnectionReconfiguration: trace fired upon RRC connection reconfiguration
  • HandoverStart: trace fired upon start of a handover procedure
  • HandoverEndOk: trace fired upon successful termination of a handover procedure
  • HandoverEndError: trace fired upon failure of a handover procedure

ns3::LteRlc

  • TxPDU: PDU transmission notified to the MAC.
  • RxPDU: PDU received.

ns3::LtePdcp

  • TxPDU: PDU transmission notified to the RLC.
  • RxPDU: PDU received.

ns3::LteEnbMac

  • DlScheduling: Information regarding DL scheduling.
  • UlScheduling: Information regarding UL scheduling.

ns3::EpcUeNas

  • StateTransition: fired upon every UE NAS state transition

ns3::LteUePowerControl

  • ReportPuschTxPower: Report PUSCH TxPower in dBm
  • ReportPucchTxPower: Report PUCCH TxPower in dBm
  • ReportSrsTxPower: Report SRS TxPower in dBm

ns3::LrWpanPhy

  • TrxStateValue: The state of the transceiver
  • TrxState: The state of the transceiver
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel.
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device
  • PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception

ns3::LrWpanMac

  • MacTxEnqueue: Trace source indicating a packet has been enqueued in the transaction queue
  • MacTxDequeue: Trace source indicating a packet has was dequeued from the transaction queue
  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxOk: Trace source indicating a packet has been successfully sent
  • MacTxDrop: Trace source indicating a packet has been dropped during transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • MacRxDrop: Trace source indicating a packet was received, but dropped before being forwarded up the stack
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
  • MacStateValue: The state of LrWpan Mac
  • MacState: The state of LrWpan Mac
  • MacSentPkt: Trace source reporting some information about the sent packet

ns3::WifiPhy

  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel. NOTE: the only official WifiPhy implementation available to this date never fires this trace source.
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device
  • PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
  • MonitorSnifferRx: Trace source simulating a wifi device in monitor mode sniffing all received frames
  • MonitorSnifferTx: Trace source simulating the capability of a wifi device in monitor mode to sniff all frames being transmitted

ns3::WifiPhyStateHelper

  • State: The state of the PHY layer
  • RxOk: A packet has been received successfully.
  • RxError: A packet has been received unsuccessfully.
  • Tx: Packet transmission is starting.

ns3::SpectrumWifiPhy

  • SignalArrival: Signal arrival

ns3::WifiMac

  • MacTx: A packet has been received from higher layers and is being processed in preparation for queueing for transmission.
  • MacTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace.
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace.
  • MacRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.

ns3::RegularWifiMac

  • TxOkHeader: The header of successfully transmitted packet.
  • TxErrHeader: The header of unsuccessfully transmitted packet.

ns3::WifiRemoteStationManager

  • MacTxRtsFailed: The transmission of a RTS by the MAC layer has failed
  • MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
  • MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
  • MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts

ns3::StaWifiMac

  • Assoc: Associated with an access point.
  • DeAssoc: Association with an access point lost.

ns3::IdealWifiManager

  • Rate: Traced value for rate changes (b/s)

ns3::MinstrelHtWifiManager

  • RateChange: The transmission rate has changed

ns3::EdcaTxopN

  • BackoffTrace: Trace source for backoff values
  • CwTrace: Trace source for contention window values

ns3::ParfWifiManager

  • PowerChange: The transmission power has change
  • RateChange: The transmission rate has change

ns3::AparfWifiManager

  • PowerChange: The transmission power has change
  • RateChange: The transmission rate has change

ns3::WifiRadioEnergyModel

  • TotalEnergyConsumption: Total energy consumption of the radio device.

ns3::dot11s::PeerManagementProtocol

  • LinkOpen: New peer link opened
  • LinkClose: New peer link closed

ns3::dot11s::HwmpProtocol

  • RouteDiscoveryTime: The time of route discovery procedure

ns3::dsr::DsrRouting

  • Tx: Send DSR packet.
  • Drop: Drop DSR packet

ns3::dsr::DsrOptions

  • Drop: Packet dropped.
  • Rx: Receive DSR packet.