ns3::FlowProbe Class Reference

#include <flow-probe.h>

Inheritance diagram for ns3::FlowProbe:

Collaboration diagram for ns3::FlowProbe:

Classes
struct	FlowStats

Public Types
typedef std::map< FlowId, FlowStats >	Stats

Public Member Functions
virtual	~FlowProbe ()
void	AddPacketDropStats (FlowId flowId, uint32_t packetSize, uint32_t reasonCode)
void	AddPacketStats (FlowId flowId, uint32_t packetSize, Time delayFromFirstProbe)
Stats	GetStats () const
void	SerializeToXmlStream (std::ostream &os, int indent, uint32_t index) const
Public Member Functions inherited from ns3::SimpleRefCount< FlowProbe >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const

Protected Member Functions
	FlowProbe (Ptr< FlowMonitor > flowMonitor)

Protected Attributes
Ptr< FlowMonitor >	m_flowMonitor
Stats	m_stats

Private Member Functions
	FlowProbe (FlowProbe const &)
FlowProbe &	operator= (FlowProbe const &)

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< FlowProbe >
static void	Cleanup (void)

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

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

Constructor & Destructor Documentation

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

private

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

protected

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

References ns3::FlowMonitor::AddProbe(), and m_flowMonitor.

Here is the call graph for this function:

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
	)

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

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

Referenced by ns3::FlowMonitor::ReportDrop().

Here is the caller graph for this function:

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

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

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

Referenced by ns3::FlowMonitor::ReportFirstTx(), ns3::FlowMonitor::ReportForwarding(), and ns3::FlowMonitor::ReportLastRx().

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.

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

References m_stats.

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

private

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

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

References INDENT, and m_stats.

Member Data Documentation

Ptr<FlowMonitor> ns3::FlowProbe::m_flowMonitor

protected

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

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

Stats ns3::FlowProbe::m_stats

protected

Definition at line 83 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