trace sink for wifi device that mimics madwifi's athstats tool. More...

#include "athstats-helper.h"

Inheritance diagram for ns3::AthstatsWifiTraceSink:

Collaboration diagram for ns3::AthstatsWifiTraceSink:

Public Member Functions
	AthstatsWifiTraceSink ()

virtual	~AthstatsWifiTraceSink ()

void	DevRxTrace (std::string context, Ptr< const Packet > p)
	function to be called when the net device receives a packet More...

void	DevTxTrace (std::string context, Ptr< const Packet > p)
	function to be called when the net device transmits a packet More...

void	Open (std::string const &name)
	Open a file for output. More...

void	PhyRxErrorTrace (std::string context, Ptr< const Packet > packet, double snr)
	Function to be called when a frame reception by the PHY layer of the considered device resulted in an error due to a failure in the CRC check of the frame. More...

void	PhyRxOkTrace (std::string context, Ptr< const Packet > packet, double snr, WifiMode mode, WifiPreamble preamble)
	Function to be called when the PHY layer of the considered device receives a frame. More...

void	PhyStateTrace (std::string context, Time start, Time duration, WifiPhyState state)
	Function to be called when the PHY layer of the considered device changes state. More...

void	PhyTxTrace (std::string context, Ptr< const Packet > packet, WifiMode mode, WifiPreamble preamble, uint8_t txPower)
	Function to be called when a frame is being transmitted by the PHY layer of the considered device. More...

void	TxDataFailedTrace (std::string context, Mac48Address address)
	Function to be called when a data frame transmission by the considered device has failed. More...

void	TxFinalDataFailedTrace (std::string context, Mac48Address address)
	Function to be called when the transmission of a data frame has exceeded the retry limit. More...

void	TxFinalRtsFailedTrace (std::string context, Mac48Address address)
	Function to be called when the transmission of a RTS frame has exceeded the retry limit. More...

void	TxRtsFailedTrace (std::string context, Mac48Address address)
	Function to be called when a RTS frame transmission by the considered device has failed. More...

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

virtual	~Object ()
	Destructor. More...

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

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

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this 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...

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

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

bool	IsInitialized (void) 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 (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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
	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 erros. 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 (void)
	Get the type ID. More...

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

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

Private Member Functions
void	ResetCounters ()
	Reset counters function. More...

void	WriteStats ()
	Write status function. More...

Private Attributes
uint32_t	m_exceededRetryCount
	exceeded retry count More...

Time	m_interval
	interval More...

uint32_t	m_longRetryCount
	long retry count More...

uint32_t	m_phyRxErrorCount
	PHY receive error count. More...

uint32_t	m_phyRxOkCount
	PHY receive OK count. More...

uint32_t	m_phyTxCount
	PHY transmit count. More...

uint32_t	m_rxCount
	receive count More...

uint32_t	m_shortRetryCount
	short retry count More...

uint32_t	m_txCount
	transmit count More...

std::ofstream *	m_writer
	output stream More...

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

virtual void	DoDispose (void)
	Destructor implementation. More...

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

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

trace sink for wifi device that mimics madwifi's athstats tool.

Introspection did not find any typical Config paths.

The AthstatsWifiTraceSink class is a trace sink to be connected to several of the traces available within a wifi device. The purpose of AthstatsWifiTraceSink is to mimic the behavior of the athstats tool distributed with the madwifi driver. In particular, the reproduced behavior is that obtained when executing athstats without parameters: a report written in text format is produced every fixed interval, based on the events observed by the wifi device.

Differences with the "real" athstats:

AthstatsWifiTraceSink is expected to write its output to a file (not to stdout).
only a subset of the metrics supported by athstats is supported by AthstatsWifiTraceSink
AthstatsWifiTraceSink does never produce a cumulative report.

Attributes

Interval: Time interval between reports
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1e+09ns
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 104 of file athstats-helper.h.

Constructor & Destructor Documentation

◆ AthstatsWifiTraceSink()

ns3::AthstatsWifiTraceSink::AthstatsWifiTraceSink ( )

Definition at line 119 of file athstats-helper.cc.

References ns3::Simulator::ScheduleNow(), and WriteStats().

Here is the call graph for this function:

◆ ~AthstatsWifiTraceSink()

ns3::AthstatsWifiTraceSink::~AthstatsWifiTraceSink ( )

virtual

Definition at line 133 of file athstats-helper.cc.

References m_writer, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Member Function Documentation

◆ DevRxTrace()

void ns3::AthstatsWifiTraceSink::DevRxTrace	(	std::string	context,
		Ptr< const Packet >	p
	)

function to be called when the net device receives a packet

Parameters

context	the calling context
p	the packet being received

Definition at line 179 of file athstats-helper.cc.

References m_rxCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ DevTxTrace()

void ns3::AthstatsWifiTraceSink::DevTxTrace	(	std::string	context,
		Ptr< const Packet >	p
	)

function to be called when the net device transmits a packet

Parameters

context	the calling context
p	the packet being transmitted

Definition at line 172 of file athstats-helper.cc.

References m_txCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::AthstatsWifiTraceSink::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 104 of file athstats-helper.cc.

References m_interval, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Open()

void ns3::AthstatsWifiTraceSink::Open ( std::string const & name )

Open a file for output.

Parameters

name	the name of the file to be opened.

Definition at line 241 of file athstats-helper.cc.

References m_writer, NS_ABORT_MSG_IF, NS_ABORT_MSG_UNLESS, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ PhyRxErrorTrace()

void ns3::AthstatsWifiTraceSink::PhyRxErrorTrace	(	std::string	context,
		Ptr< const Packet >	packet,
		double	snr
	)

Function to be called when a frame reception by the PHY layer of the considered device resulted in an error due to a failure in the CRC check of the frame.

Parameters

context	the calling context
packet	the packet
snr	the SNR in linear scale

Definition at line 221 of file athstats-helper.cc.

References m_phyRxErrorCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ PhyRxOkTrace()

void ns3::AthstatsWifiTraceSink::PhyRxOkTrace	(	std::string	context,
		Ptr< const Packet >	packet,
		double	snr,
		WifiMode	mode,
		WifiPreamble	preamble
	)

Function to be called when the PHY layer of the considered device receives a frame.

Parameters

context	the calling context
packet	the packet
snr	the SNR in linear scale
mode	the WifiMode
preamble	the wifi preamble

Definition at line 214 of file athstats-helper.cc.

References m_phyRxOkCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ PhyStateTrace()

void ns3::AthstatsWifiTraceSink::PhyStateTrace	(	std::string	context,
		Time	start,
		Time	duration,
		WifiPhyState	state
	)

Function to be called when the PHY layer of the considered device changes state.

Parameters

context	the calling context
start	the time at which the state changed
duration	the duration of the state
state	the PHY layer state

Definition at line 235 of file athstats-helper.cc.

References NS_LOG_FUNCTION, and visualizer.core::start().

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PhyTxTrace()

void ns3::AthstatsWifiTraceSink::PhyTxTrace	(	std::string	context,
		Ptr< const Packet >	packet,
		WifiMode	mode,
		WifiPreamble	preamble,
		uint8_t	txPower
	)

Function to be called when a frame is being transmitted by the PHY layer of the considered device.

Parameters

context	the calling context
packet	the packet
mode	the WifiMode
preamble	the wifi preamble
txPower	the transmit power level

Definition at line 228 of file athstats-helper.cc.

References m_phyTxCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ ResetCounters()

void ns3::AthstatsWifiTraceSink::ResetCounters ( )

private

Reset counters function.

Definition at line 159 of file athstats-helper.cc.

References m_exceededRetryCount, m_longRetryCount, m_phyRxErrorCount, m_phyRxOkCount, m_phyTxCount, m_rxCount, m_shortRetryCount, and m_txCount.

Referenced by WriteStats().

Here is the caller graph for this function:

◆ TxDataFailedTrace()

void ns3::AthstatsWifiTraceSink::TxDataFailedTrace	(	std::string	context,
		Mac48Address	address
	)

Function to be called when a data frame transmission by the considered device has failed.

Parameters

context	the calling context
address	the MAC address of the remote station

Definition at line 193 of file athstats-helper.cc.

References first::address, m_longRetryCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ TxFinalDataFailedTrace()

void ns3::AthstatsWifiTraceSink::TxFinalDataFailedTrace	(	std::string	context,
		Mac48Address	address
	)

Function to be called when the transmission of a data frame has exceeded the retry limit.

Parameters

context	the calling context
address	the MAC address of the remote station

Definition at line 207 of file athstats-helper.cc.

References first::address, m_exceededRetryCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ TxFinalRtsFailedTrace()

void ns3::AthstatsWifiTraceSink::TxFinalRtsFailedTrace	(	std::string	context,
		Mac48Address	address
	)

Function to be called when the transmission of a RTS frame has exceeded the retry limit.

Parameters

context	the calling context
address	the MAC address of the remote station

Definition at line 200 of file athstats-helper.cc.

References first::address, m_exceededRetryCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ TxRtsFailedTrace()

void ns3::AthstatsWifiTraceSink::TxRtsFailedTrace	(	std::string	context,
		Mac48Address	address
	)

Function to be called when a RTS frame transmission by the considered device has failed.

Parameters

context	the calling context
address	the MAC address of the remote station

Definition at line 186 of file athstats-helper.cc.

References first::address, m_shortRetryCount, and NS_LOG_FUNCTION.

Referenced by ns3::AthstatsHelper::EnableAthstats().

Here is the caller graph for this function:

◆ WriteStats()

void ns3::AthstatsWifiTraceSink::WriteStats ( )

private

Write status function.

Definition at line 260 of file athstats-helper.cc.

References m_exceededRetryCount, m_interval, m_longRetryCount, m_phyRxErrorCount, m_rxCount, m_shortRetryCount, m_txCount, m_writer, NS_LOG_FUNCTION, ResetCounters(), and ns3::Simulator::Schedule().

Referenced by AthstatsWifiTraceSink().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_exceededRetryCount

uint32_t ns3::AthstatsWifiTraceSink::m_exceededRetryCount

private

exceeded retry count

Definition at line 231 of file athstats-helper.h.

Referenced by ResetCounters(), TxFinalDataFailedTrace(), TxFinalRtsFailedTrace(), and WriteStats().

◆ m_interval

Time ns3::AthstatsWifiTraceSink::m_interval

private

interval

Definition at line 238 of file athstats-helper.h.

Referenced by GetTypeId(), and WriteStats().

◆ m_longRetryCount

uint32_t ns3::AthstatsWifiTraceSink::m_longRetryCount

private

long retry count

Definition at line 230 of file athstats-helper.h.

Referenced by ResetCounters(), TxDataFailedTrace(), and WriteStats().

◆ m_phyRxErrorCount

uint32_t ns3::AthstatsWifiTraceSink::m_phyRxErrorCount

private

PHY receive error count.

Definition at line 233 of file athstats-helper.h.

Referenced by PhyRxErrorTrace(), ResetCounters(), and WriteStats().

◆ m_phyRxOkCount

uint32_t ns3::AthstatsWifiTraceSink::m_phyRxOkCount

private

PHY receive OK count.

Definition at line 232 of file athstats-helper.h.

Referenced by PhyRxOkTrace(), and ResetCounters().

◆ m_phyTxCount

uint32_t ns3::AthstatsWifiTraceSink::m_phyTxCount

private

PHY transmit count.

Definition at line 234 of file athstats-helper.h.

Referenced by PhyTxTrace(), and ResetCounters().

◆ m_rxCount

uint32_t ns3::AthstatsWifiTraceSink::m_rxCount

private

receive count

Definition at line 228 of file athstats-helper.h.

Referenced by DevRxTrace(), ResetCounters(), and WriteStats().

◆ m_shortRetryCount

uint32_t ns3::AthstatsWifiTraceSink::m_shortRetryCount

private

short retry count

Definition at line 229 of file athstats-helper.h.

Referenced by ResetCounters(), TxRtsFailedTrace(), and WriteStats().

◆ m_txCount

uint32_t ns3::AthstatsWifiTraceSink::m_txCount

private

transmit count

Definition at line 227 of file athstats-helper.h.

Referenced by DevTxTrace(), ResetCounters(), and WriteStats().

◆ m_writer

std::ofstream* ns3::AthstatsWifiTraceSink::m_writer

private

output stream

Definition at line 236 of file athstats-helper.h.

Referenced by ~AthstatsWifiTraceSink(), Open(), and WriteStats().

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

src/wifi/helper/athstats-helper.h
src/wifi/helper/athstats-helper.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ AthstatsWifiTraceSink()

◆ ~AthstatsWifiTraceSink()

Member Function Documentation

◆ DevRxTrace()

◆ DevTxTrace()

◆ GetTypeId()

◆ Open()

◆ PhyRxErrorTrace()

◆ PhyRxOkTrace()

◆ PhyStateTrace()

◆ PhyTxTrace()

◆ ResetCounters()

◆ TxDataFailedTrace()

◆ TxFinalDataFailedTrace()

◆ TxFinalRtsFailedTrace()

◆ TxRtsFailedTrace()

◆ WriteStats()

Member Data Documentation

◆ m_exceededRetryCount

◆ m_interval

◆ m_longRetryCount

◆ m_phyRxErrorCount

◆ m_phyRxOkCount

◆ m_phyTxCount

◆ m_rxCount

◆ m_shortRetryCount

◆ m_txCount

◆ m_writer