Probe to translate from a TraceSource to two more easily parsed TraceSources. More...

#include "application-packet-probe.h"

Inheritance diagram for ns3::ApplicationPacketProbe:

Collaboration diagram for ns3::ApplicationPacketProbe:

Public Member Functions
	ApplicationPacketProbe ()

	~ApplicationPacketProbe () override

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

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

void	SetValue (Ptr< const Packet > packet, const Address &address)
	Set a probe value.

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.

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

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

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

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

	~Object () override
	Destructor.

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

void	Dispose ()
	Dispose of this Object.

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

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

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

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

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

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

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

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

static void	SetValueByPath (std::string path, Ptr< const Packet > packet, const Address &address)
	Set a probe value by its name in the Config system.

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

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

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

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

Private Attributes
Address	m_address
	The socket address for the traced packet.

TracedCallback< Ptr< const Packet >, const Address & >	m_output
	Output trace, packet and source address.

TracedCallback< uint32_t, uint32_t >	m_outputBytes
	Output trace, previous packet size and current packet size.

Ptr< const Packet >	m_packet
	The traced packet.

uint32_t	m_packetSizeOld
	The size of the traced packet.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Protected Attributes inherited from ns3::Probe
Time	m_start
	Time when logging starts.

Time	m_stop
	Time when logging stops.

Protected Attributes inherited from ns3::DataCollectionObject
bool	m_enabled
	Object's activation state.

std::string	m_name
	Name of the object within the data collection framework.

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

Detailed Description

Probe to translate from a TraceSource to two more easily parsed TraceSources.

This class is designed to probe an underlying ns3 TraceSource exporting a packet and a socket address. This probe exports a trace source "Output" with arguments of type Ptr<const Packet> and const Address&. 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.

Definition at line 40 of file application-packet-probe.h.