The FlowProbe class is responsible for listening for packet events in a specific point of the simulated space, report those events to the global FlowMonitor, and collect its own flow statistics regarding only the packets that pass through that probe. More...

#include <flow-probe.h>

Inheritance diagram for ns3::FlowProbe:

Collaboration diagram for ns3::FlowProbe:

Classes
struct	FlowStats
	Structure to hold the statistics of a flow. More...

Public Types
typedef std::map< FlowId, FlowStats >	Stats
	Container to map FlowId -> FlowStats. More...

Public Member Functions
virtual	~FlowProbe ()

void	AddPacketDropStats (FlowId flowId, uint32_t packetSize, uint32_t reasonCode)
	Add a packet drop data to the flow stats. More...

void	AddPacketStats (FlowId flowId, uint32_t packetSize, Time delayFromFirstProbe)
	Add a packet data to the flow stats. More...

Stats	GetStats () const
	Get the partial flow statistics stored in this probe. More...

void	SerializeToXmlStream (std::ostream &os, int indent, uint32_t index) const
	Serializes the results to an std::ostream in XML format. More...

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Protected Member Functions
	FlowProbe (Ptr< FlowMonitor > flowMonitor)
	Constructor. More...

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Protected Attributes
Ptr< FlowMonitor >	m_flowMonitor
	the FlowMonitor instance More...

Stats	m_stats
	The flow stats. More...

Private Member Functions
	FlowProbe (FlowProbe const &)
	Defined and not implemented to avoid misuse. More...

FlowProbe &	operator= (FlowProbe const &)
	Defined and not implemented to avoid misuse. More...

Additional Inherited Members
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Detailed Description

The FlowProbe class is responsible for listening for packet events in a specific point of the simulated space, report those events to the global FlowMonitor, and collect its own flow statistics regarding only the packets that pass through that probe.

Definition at line 39 of file flow-probe.h.

Member Typedef Documentation

typedef std::map<FlowId, FlowStats> ns3::FlowProbe::Stats

Container to map FlowId -> FlowStats.

Definition at line 76 of file flow-probe.h.

Constructor & Destructor Documentation

ns3::FlowProbe::FlowProbe ( FlowProbe const & )

private

Defined and not implemented to avoid misuse.

ns3::FlowProbe::FlowProbe ( Ptr< FlowMonitor > flowMonitor )

protected

Constructor.

Parameters

flowMonitor the FlowMonitor this probe is associated with

Definition at line 32 of file flow-probe.cc.

References m_flowMonitor.

ns3::FlowProbe::~FlowProbe ( )

virtual

Definition at line 27 of file flow-probe.cc.

Member Function Documentation

void ns3::FlowProbe::AddPacketDropStats	(	FlowId	flowId,
		uint32_t	packetSize,
		uint32_t	reasonCode
	)

Add a packet drop data to the flow stats.

Parameters

flowId	the flow Identifier
packetSize	the packet size
reasonCode	reason code for the drop

Definition at line 55 of file flow-probe.cc.

References ns3::FlowProbe::FlowStats::bytesDropped, m_stats, and ns3::FlowProbe::FlowStats::packetsDropped.

void ns3::FlowProbe::AddPacketStats	(	FlowId	flowId,
		uint32_t	packetSize,
		Time	delayFromFirstProbe
	)

Add a packet data to the flow stats.

Parameters

flowId	the flow Identifier
packetSize	the packet size
delayFromFirstProbe	packet delay

Definition at line 46 of file flow-probe.cc.

References ns3::FlowProbe::FlowStats::bytes, ns3::FlowProbe::FlowStats::delayFromFirstProbeSum, m_stats, and ns3::FlowProbe::FlowStats::packets.

void ns3::FlowProbe::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::Ipv6FlowProbe, and ns3::Ipv4FlowProbe.

Definition at line 39 of file flow-probe.cc.

References ns3::Object::DoDispose(), and m_flowMonitor.

Referenced by ns3::Ipv4FlowProbe::DoDispose(), and ns3::Ipv6FlowProbe::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

FlowProbe::Stats ns3::FlowProbe::GetStats ( ) const

Get the partial flow statistics stored in this probe.

With this information you can, for example, find out what is the delay from the first probe to this one.

Returns: the partial flow statistics

Definition at line 69 of file flow-probe.cc.

References m_stats.

FlowProbe& ns3::FlowProbe::operator= ( FlowProbe const & )

private

Defined and not implemented to avoid misuse.

Returns

void ns3::FlowProbe::SerializeToXmlStream	(	std::ostream &	os,
		int	indent,
		uint32_t	index
	)		const

Serializes the results to an std::ostream in XML format.

Parameters

os	the output stream
indent	number of spaces to use as base indentation level
index	FlowProbe index

Definition at line 75 of file flow-probe.cc.

References INDENT, and m_stats.

Member Data Documentation

Ptr<FlowMonitor> ns3::FlowProbe::m_flowMonitor

protected

the FlowMonitor instance

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

Referenced by DoDispose(), ns3::Ipv4FlowProbe::DropLogger(), ns3::Ipv6FlowProbe::DropLogger(), FlowProbe(), ns3::Ipv4FlowProbe::ForwardLogger(), ns3::Ipv6FlowProbe::ForwardLogger(), ns3::Ipv4FlowProbe::ForwardUpLogger(), ns3::Ipv6FlowProbe::ForwardUpLogger(), ns3::Ipv4FlowProbe::QueueDropLogger(), ns3::Ipv6FlowProbe::QueueDropLogger(), ns3::Ipv4FlowProbe::SendOutgoingLogger(), and ns3::Ipv6FlowProbe::SendOutgoingLogger().

Stats ns3::FlowProbe::m_stats

protected

The flow stats.

Definition at line 103 of file flow-probe.h.

Referenced by AddPacketDropStats(), AddPacketStats(), GetStats(), and SerializeToXmlStream().

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

src/flow-monitor/model/flow-probe.h
src/flow-monitor/model/flow-probe.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation