This class is designed to probe an underlying ns3 TraceSource exporting a packet. More...

#include "packet-probe.h"

Inheritance diagram for ns3::PacketProbe:

Collaboration diagram for ns3::PacketProbe:

Public Member Functions
	PacketProbe ()

	~PacketProbe () override

bool	ConnectByObject (std::string traceSource, Ptr< Object > obj) override
	connect to a trace source attribute provided by a given object More...

void	ConnectByPath (std::string path) override
	connect to a trace source provided by a config path More...

void	SetValue (Ptr< const Packet > packet)
	Set a probe value. More...

Public Member Functions inherited from ns3::Probe
	Probe ()

	~Probe () override

bool	IsEnabled () const override

Public Member Functions inherited from ns3::DataCollectionObject
	DataCollectionObject ()

	~DataCollectionObject () override

void	Disable ()
	Unset the status of an individual object. More...

void	Enable ()
	Set the status of an individual object. More...

std::string	GetName () const
	Get the object's name. More...

void	SetName (std::string name)
	Set the object's name. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () 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< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () 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[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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 errors. 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)
	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 ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Member Functions
void	TraceSink (Ptr< const Packet > packet)
	Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> More...

Private Attributes
TracedCallback< Ptr< const Packet > >	m_output
	Traced callback: packet received. More...

TracedCallback< uint32_t, uint32_t >	m_outputBytes
	Traced callback: size of previous packet receive, size of actual packet received. More...

Ptr< const Packet >	m_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 ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	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 ()
	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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

This class is designed to probe an underlying ns3 TraceSource exporting a packet.

Introspection did not find any typical Config paths.

This probe exports a trace source "Output" with argument of type Ptr<const Packet>. This probe exports another trace source "OutputBytes" with arguments of type uint32_t, which is the number of bytes in the packet. The trace sources emit values when either the probed 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: constructwriteread
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: constructwriteread

Attributes defined in parent class ns3::DataCollectionObject

Enabled: Object's enabled status
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
Name: Object's name
- Set with class: ns3::StringValue
- Underlying type: std::string
- Initial value: unnamed
- Flags: constructwriteread

TraceSources

Output: The packet that serve as the output for this probe
Callback signature: ns3::Packet::TracedCallback
OutputBytes: The number of bytes in the packet
Callback signature: ns3::Packet::SizeTracedCallback

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

Definition at line 47 of file packet-probe.h.

Constructor & Destructor Documentation

◆ PacketProbe()

ns3::PacketProbe::PacketProbe ( )

Definition at line 56 of file packet-probe.cc.

References m_packet, and NS_LOG_FUNCTION.

◆ ~PacketProbe()

ns3::PacketProbe::~PacketProbe ( )

override

Definition at line 62 of file packet-probe.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ConnectByObject()

bool ns3::PacketProbe::ConnectByObject	(	std::string	traceSource,
		Ptr< Object >	obj
	)

overridevirtual

connect to a trace source attribute provided by a given object

Parameters

traceSource	the name of the attribute TraceSource to connect to
obj	ns3::Object to connect to

Returns: true if the trace source was successfully connected

Implements ns3::Probe.

Definition at line 89 of file 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::PacketProbe::ConnectByPath ( std::string path )

overridevirtual

connect to a trace source provided by a config path

Parameters

path	Config 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 100 of file packet-probe.cc.

References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, check-style-clang-format::path, and TraceSink().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::PacketProbe::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 39 of file 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::PacketProbe::SetValue ( Ptr< const Packet > packet )

Set a probe value.

Parameters

packet set the traced packet equal to this

Definition at line 68 of file packet-probe.cc.

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

Here is the call graph for this function:

◆ SetValueByPath()

void ns3::PacketProbe::SetValueByPath	(	std::string	path,
		Ptr< const Packet >	packet
	)

static

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

Parameters

path	config path to access the probe
packet	set the traced packet equal to this

Definition at line 80 of file packet-probe.cc.

References NS_ASSERT_MSG, NS_LOG_FUNCTION, and check-style-clang-format::path.

◆ TraceSink()

void ns3::PacketProbe::TraceSink ( Ptr< const Packet > packet )

private

Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>

Parameters

packet the traced packet

Definition at line 108 of file packet-probe.cc.

References ns3::Packet::GetSize(), ns3::Probe::IsEnabled(), 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_output

TracedCallback<Ptr<const Packet> > ns3::PacketProbe::m_output

private

Traced callback: packet received.

Definition at line 102 of file packet-probe.h.

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

◆ m_outputBytes

TracedCallback<uint32_t, uint32_t> ns3::PacketProbe::m_outputBytes

private

Traced callback: size of previous packet receive, size of actual packet received.

Definition at line 104 of file packet-probe.h.

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

◆ m_packet

Ptr<const Packet> ns3::PacketProbe::m_packet

private

The traced packet.

Definition at line 107 of file packet-probe.h.

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

◆ m_packetSizeOld

uint32_t ns3::PacketProbe::m_packetSizeOld

private

The size of the traced packet.

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

Referenced by SetValue(), and TraceSink().

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

src/network/utils/packet-probe.h
src/network/utils/packet-probe.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes defined in parent class ns3::Probe

Attributes defined in parent class ns3::DataCollectionObject

TraceSources

Constructor & Destructor Documentation

◆ PacketProbe()

◆ ~PacketProbe()

Member Function Documentation

◆ ConnectByObject()

◆ ConnectByPath()

◆ GetTypeId()

◆ SetValue()

◆ SetValueByPath()

◆ TraceSink()

Member Data Documentation

◆ m_output

◆ m_outputBytes

◆ m_packet

◆ m_packetSizeOld