A Discrete-Event Network Simulator
API
ns3::Ipv4PacketProbe Class Reference

This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object, and an interface. More...

#include "ipv4-packet-probe.h"

+ Inheritance diagram for ns3::Ipv4PacketProbe:
+ Collaboration diagram for ns3::Ipv4PacketProbe:

Public Member Functions

 Ipv4PacketProbe ()
 
virtual ~Ipv4PacketProbe ()
 
virtual bool ConnectByObject (std::string traceSource, Ptr< Object > obj)
 connect to a trace source attribute provided by a given object More...
 
virtual void ConnectByPath (std::string path)
 connect to a trace source provided by a config path More...
 
void SetValue (Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
 Set a probe value. More...
 
- Public Member Functions inherited from ns3::Probe
 Probe ()
 
virtual ~Probe ()
 
virtual bool ConnectByObject (std::string traceSource, Ptr< Object > obj)=0
 connect to a trace source attribute provided by a given object More...
 
virtual void ConnectByPath (std::string path)=0
 connect to a trace source provided by a config path More...
 
virtual bool IsEnabled (void) const
 
- Public Member Functions inherited from ns3::DataCollectionObject
 DataCollectionObject ()
 
virtual ~DataCollectionObject ()
 
void Disable (void)
 Unset the status of an individual object. More...
 
void Enable (void)
 Set the status of an individual object. More...
 
std::string GetName (void) const
 Get the object's name. More...
 
virtual bool IsEnabled (void) const
 Check the status of an individual object. More...
 
void SetName (std::string name)
 Set the object's name. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
static void SetValueByPath (std::string path, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
 Set a probe value by its name in the Config system. More...
 
- Static Public Member Functions inherited from ns3::Probe
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::DataCollectionObject
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

void TraceSink (Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
 Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t. More...
 

Private Attributes

uint32_t m_interface
 The IPv4 interface for the traced packet. More...
 
Ptr< Ipv4m_ipv4
 The IPv4 object for the traced packet. More...
 
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_tm_output
 Traced Callback: the packet, the Ipv4 object and the interface. More...
 
ns3::TracedCallback< uint32_t, uint32_tm_outputBytes
 Traced Callback: the previous packet's size and the actual packet's size. More...
 
Ptr< const Packetm_packet
 The traced packet. More...
 
uint32_t m_packetSizeOld
 The size of the traced packet. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Protected Attributes inherited from ns3::Probe
Time m_start
 Time when logging starts. More...
 
Time m_stop
 Time when logging stops. More...
 
- Protected Attributes inherited from ns3::DataCollectionObject
bool m_enabled
 Object's activation state. More...
 
std::string m_name
 Name of the object within the data collection framework. More...
 

Detailed Description

This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object, and an interface.

Introspection did not find any typical Config paths.

This probe exports a trace source "Output" with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t. The Output trace source emits a value when either the trace source emits a new value, or when SetValue () is called.


No Attributes are defined for this type.

Attributes defined in parent class ns3::Probe

  • Start: Time data collection starts
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • Stop: Time when data collection stops. The special time value of 0 disables this attribute
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read

Attributes defined in parent class ns3::DataCollectionObject

  • Name: Object's name
    • Set with class: StringValue
    • Underlying type:
    • Initial value: unnamed
    • Flags: construct write read
  • Enabled: Object's enabled status
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources

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

Definition at line 49 of file ipv4-packet-probe.h.

Constructor & Destructor Documentation

◆ Ipv4PacketProbe()

ns3::Ipv4PacketProbe::Ipv4PacketProbe ( )

Definition at line 57 of file ipv4-packet-probe.cc.

References m_interface, m_ipv4, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.

◆ ~Ipv4PacketProbe()

ns3::Ipv4PacketProbe::~Ipv4PacketProbe ( )
virtual

Definition at line 66 of file ipv4-packet-probe.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ConnectByObject()

bool ns3::Ipv4PacketProbe::ConnectByObject ( std::string  traceSource,
Ptr< Object obj 
)
virtual

connect to a trace source attribute provided by a given object

Parameters
traceSourcethe name of the attribute TraceSource to connect to
objns3::Object to connect to
Returns
true if the trace source was successfully connected

Implements ns3::Probe.

Definition at line 95 of file ipv4-packet-probe.cc.

References ns3::Names::FindPath(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectBase::TraceConnectWithoutContext(), and TraceSink().

+ Here is the call graph for this function:

◆ ConnectByPath()

void ns3::Ipv4PacketProbe::ConnectByPath ( std::string  path)
virtual

connect to a trace source provided by a config path

Parameters
pathConfig path to bind to

Note, if an invalid path is provided, the probe will not be connected to anything.

Implements ns3::Probe.

Definition at line 104 of file ipv4-packet-probe.cc.

References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv4PacketProbe::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 38 of file ipv4-packet-probe.cc.

References m_output, m_outputBytes, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetValue()

void ns3::Ipv4PacketProbe::SetValue ( Ptr< const Packet packet,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)

Set a probe value.

Parameters
packetset the traced packet equal to this
ipv4set the IPv4 object for the traced packet equal to this
interfaceset the IPv4 interface for the traced packet equal to this

Definition at line 72 of file ipv4-packet-probe.cc.

References ns3::Packet::GetSize(), m_interface, m_ipv4, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetValueByPath()

void ns3::Ipv4PacketProbe::SetValueByPath ( std::string  path,
Ptr< const Packet packet,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)
static

Set a probe value by its name in the Config system.

Parameters
pathconfig path to access the probe
packetset the traced packet equal to this
ipv4set the IPv4 object for the traced packet equal to this
interfaceset the IPv4 interface for the traced packet equal to this

Definition at line 86 of file ipv4-packet-probe.cc.

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ TraceSink()

void ns3::Ipv4PacketProbe::TraceSink ( Ptr< const Packet packet,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)
private

Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t.

Parameters
packetthe traced packet
ipv4the IPv4 object for the traced packet
interfacethe IPv4 interface for the traced packet

Definition at line 112 of file ipv4-packet-probe.cc.

References ns3::Packet::GetSize(), ns3::Probe::IsEnabled(), m_interface, m_ipv4, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.

Referenced by ConnectByObject(), and ConnectByPath().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_interface

uint32_t ns3::Ipv4PacketProbe::m_interface
private

The IPv4 interface for the traced packet.

Definition at line 121 of file ipv4-packet-probe.h.

Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().

◆ m_ipv4

Ptr<Ipv4> ns3::Ipv4PacketProbe::m_ipv4
private

The IPv4 object for the traced packet.

Definition at line 118 of file ipv4-packet-probe.h.

Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().

◆ m_output

ns3::TracedCallback<Ptr<const Packet>, Ptr<Ipv4>, uint32_t> ns3::Ipv4PacketProbe::m_output
private

Traced Callback: the packet, the Ipv4 object and the interface.

Definition at line 110 of file ipv4-packet-probe.h.

Referenced by GetTypeId(), SetValue(), and TraceSink().

◆ m_outputBytes

ns3::TracedCallback<uint32_t, uint32_t> ns3::Ipv4PacketProbe::m_outputBytes
private

Traced Callback: the previous packet's size and the actual packet's size.

Definition at line 112 of file ipv4-packet-probe.h.

Referenced by GetTypeId(), SetValue(), and TraceSink().

◆ m_packet

Ptr<const Packet> ns3::Ipv4PacketProbe::m_packet
private

The traced packet.

Definition at line 115 of file ipv4-packet-probe.h.

Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().

◆ m_packetSizeOld

uint32_t ns3::Ipv4PacketProbe::m_packetSizeOld
private

The size of the traced packet.

Definition at line 124 of file ipv4-packet-probe.h.

Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().


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