A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::FlowProbe Class Reference

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, FlowStatsStats
 Container to map FlowId -> FlowStats.
 

Public Member Functions

 FlowProbe (const FlowProbe &)=delete
 
 ~FlowProbe () override
 
void AddPacketDropStats (FlowId flowId, uint32_t packetSize, uint32_t reasonCode)
 Add a packet drop data to the flow stats.
 
void AddPacketStats (FlowId flowId, uint32_t packetSize, Time delayFromFirstProbe)
 Add a packet data to the flow stats.
 
Stats GetStats () const
 Get the partial flow statistics stored in this probe.
 
FlowProbeoperator= (const FlowProbe &)=delete
 
void SerializeToXmlStream (std::ostream &os, uint16_t indent, uint32_t index) const
 Serializes the results to an std::ostream in XML format.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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 ()
 Register this type.
 
- 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.
 

Protected Member Functions

 FlowProbe (Ptr< FlowMonitor > flowMonitor)
 Constructor.
 
void DoDispose () override
 Destructor implementation.
 
- 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

Ptr< FlowMonitorm_flowMonitor
 the FlowMonitor instance
 
Stats m_stats
 The flow stats.
 

Additional Inherited Members

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 40 of file flow-probe.h.

Member Typedef Documentation

◆ Stats

Container to map FlowId -> FlowStats.

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

Constructor & Destructor Documentation

◆ FlowProbe() [1/2]

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

Constructor.

Parameters
flowMonitorthe FlowMonitor this probe is associated with

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

References m_flowMonitor.

◆ ~FlowProbe()

ns3::FlowProbe::~FlowProbe ( )
override

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

◆ FlowProbe() [2/2]

ns3::FlowProbe::FlowProbe ( const FlowProbe )
delete

Member Function Documentation

◆ AddPacketDropStats()

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

Add a packet drop data to the flow stats.

Parameters
flowIdthe flow Identifier
packetSizethe packet size
reasonCodereason code for the drop

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

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

◆ AddPacketStats()

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

Add a packet data to the flow stats.

Parameters
flowIdthe flow Identifier
packetSizethe packet size
delayFromFirstProbepacket delay

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

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

◆ DoDispose()

void ns3::FlowProbe::DoDispose ( )
overrideprotectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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::Ipv4FlowProbe, and ns3::Ipv6FlowProbe.

Definition at line 49 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:

◆ GetStats()

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 79 of file flow-probe.cc.

References m_stats.

◆ GetTypeId()

TypeId ns3::FlowProbe::GetTypeId ( )
static

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

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

◆ SerializeToXmlStream()

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

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

Parameters
osthe output stream
indentnumber of spaces to use as base indentation level
indexFlowProbe index

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

References m_stats.

Member Data Documentation

◆ m_flowMonitor

◆ m_stats

Stats ns3::FlowProbe::m_stats
protected

The flow stats.

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

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


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