Aggregator used to construct A-MSDUs. More...

#include "msdu-aggregator.h"

Inheritance diagram for ns3::MsduAggregator:

Collaboration diagram for ns3::MsduAggregator:

Public Types
typedef std::map< AcIndex, Ptr< QosTxop > >	EdcaQueues
	EDCA queues typedef.

Public Member Functions
	MsduAggregator ()=default

	~MsduAggregator () override=default

uint16_t	GetMaxAmsduSize (Mac48Address recipient, uint8_t tid, WifiModulationClass modulation) const
	Determine the maximum size for an A-MSDU of the given TID that can be sent to the given receiver when using the given modulation class.

Ptr< WifiMpdu >	GetNextAmsdu (Ptr< WifiMpdu > peekedItem, WifiTxParameters &txParams, Time availableTime) const
	Attempt to aggregate other MSDUs to the given A-MSDU while meeting the following constraints:

void	SetLinkId (uint8_t linkId)
	Set the ID of the link this MSDU aggregator is associated with.

void	SetWifiMac (const Ptr< WifiMac > mac)
	Set the MAC layer to use.

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 uint8_t	CalculatePadding (uint16_t amsduSize)
	Calculate how much padding must be added to the end of an A-MSDU of the given size if a new MSDU is added.

static WifiMpdu::DeaggregatedMsdus	Deaggregate (Ptr< Packet > aggregatedPacket)

static uint16_t	GetSizeIfAggregated (uint16_t msduSize, uint16_t amsduSize)
	Compute the size of the A-MSDU resulting from the aggregation of an MSDU of size msduSize and an A-MSDU of size amsduSize.

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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

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.

Private Attributes
Ptr< HtFrameExchangeManager >	m_htFem
	the HT Frame Exchange Manager of this station

uint8_t	m_linkId {0}
	ID of the link this object is connected to.

Ptr< WifiMac >	m_mac
	the MAC of this station

Additional Inherited Members
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

Aggregator used to construct A-MSDUs.

Definition at line 35 of file msdu-aggregator.h.

Member Typedef Documentation

◆ EdcaQueues

typedef std::map<AcIndex, Ptr<QosTxop> > ns3::MsduAggregator::EdcaQueues

EDCA queues typedef.

Definition at line 39 of file msdu-aggregator.h.

Constructor & Destructor Documentation

◆ MsduAggregator()

ns3::MsduAggregator::MsduAggregator ( )

default

◆ ~MsduAggregator()

ns3::MsduAggregator::~MsduAggregator ( )

overridedefault

Member Function Documentation

◆ CalculatePadding()

uint8_t ns3::MsduAggregator::CalculatePadding ( uint16_t amsduSize )

static

Calculate how much padding must be added to the end of an A-MSDU of the given size if a new MSDU is added.

Each A-MSDU subframe is padded so that its length is multiple of 4 octets.

Parameters

amsduSize the size of the A-MSDU

Returns: the number of octets required for padding

Definition at line 151 of file msdu-aggregator.cc.

Referenced by ns3::WifiMpdu::DoAggregate(), and GetSizeIfAggregated().

Here is the caller graph for this function:

◆ Deaggregate()

WifiMpdu::DeaggregatedMsdus ns3::MsduAggregator::Deaggregate ( Ptr< Packet > aggregatedPacket )

static

Parameters

aggregatedPacket the aggregated packet.

Returns: DeaggregatedMsdus.

Definition at line 264 of file msdu-aggregator.cc.

References ns3::Create(), ns3::AmsduSubframeHeader::GetLength(), NS_LOG_FUNCTION_NOARGS, and NS_LOG_INFO.

Referenced by ns3::WifiMpdu::WifiMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::MsduAggregator::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.

Definition at line 44 of file msdu-aggregator.cc.

References ns3::Object::DoDispose(), m_htFem, and m_mac.

Here is the call graph for this function:

◆ GetMaxAmsduSize()

uint16_t ns3::MsduAggregator::GetMaxAmsduSize	(	Mac48Address	recipient,
		uint8_t	tid,
		WifiModulationClass	modulation ) const

Determine the maximum size for an A-MSDU of the given TID that can be sent to the given receiver when using the given modulation class.

Parameters

recipient	the receiver station address.
tid	the TID.
modulation	the modulation class.

Returns: the maximum A-MSDU size in bytes.

Definition at line 157 of file msdu-aggregator.cc.

References m_linkId, m_mac, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WIFI_MOD_CLASS_EHT, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, ns3::WIFI_MOD_CLASS_VHT, ns3::WIFI_PHY_BAND_2_4GHZ, and ns3::WIFI_STANDARD_80211be.

Referenced by GetNextAmsdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNextAmsdu()

Ptr< WifiMpdu > ns3::MsduAggregator::GetNextAmsdu	(	Ptr< WifiMpdu >	peekedItem,
		WifiTxParameters &	txParams,
		Time	availableTime ) const

Attempt to aggregate other MSDUs to the given A-MSDU while meeting the following constraints:

the A-MSDU size does not exceed the maximum A-MSDU size as determined for the modulation class indicated by the given TxVector
the size of the A-MPDU resulting from the aggregation of the MPDU in which the A-MSDU will be embedded and the current A-MPDU (as specified by the given TX parameters) does not exceed the maximum A-MPDU size as determined for the modulation class indicated by the given TxVector
the time to transmit the resulting PPDU, according to the given TxVector, does not exceed the maximum PPDU duration allowed by the corresponding modulation class (if any)
the time to transmit the resulting PPDU and to carry out protection and acknowledgment, as specified by the given TX parameters, does not exceed the given available time (if distinct from Time::Min ())

If aggregation succeeds (it was possible to aggregate at least an MSDU to the given MSDU), all the aggregated MSDUs are dequeued and an MPDU containing the A-MSDU is enqueued in the queue (replacing the given MPDU) and returned. Otherwise, no MSDU is dequeued from the EDCA queue and a null pointer is returned.

Parameters

peekedItem	the MSDU which we attempt to aggregate other MSDUs to
txParams	the TX parameters for the current frame
availableTime	the time available for the frame exchange

Returns: the resulting A-MSDU, if aggregation is possible, a null pointer otherwise.

Definition at line 80 of file msdu-aggregator.cc.

References GetMaxAmsduSize(), ns3::WifiTxVector::GetModulationClass(), m_htFem, m_mac, ns3::WifiTxParameters::m_txVector, NS_ABORT_MSG_IF, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetSizeIfAggregated()

uint16_t ns3::MsduAggregator::GetSizeIfAggregated	(	uint16_t	msduSize,
		uint16_t	amsduSize )

static

Compute the size of the A-MSDU resulting from the aggregation of an MSDU of size msduSize and an A-MSDU of size amsduSize.

Note that only the basic A-MSDU subframe format (section 9.3.2.2.2 of IEEE 802.11-2016) is supported.

Parameters

msduSize	the MSDU size in bytes.
amsduSize	the A-MSDU size in bytes.

Returns: the size of the resulting A-MSDU in bytes.

Definition at line 71 of file msdu-aggregator.cc.

References CalculatePadding(), and NS_LOG_FUNCTION.

Referenced by ns3::WifiTxParameters::GetSizeIfAggregateMsdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MsduAggregator::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 34 of file msdu-aggregator.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetLinkId()

void ns3::MsduAggregator::SetLinkId ( uint8_t linkId )

Set the ID of the link this MSDU aggregator is associated with.

Parameters

linkId the ID of the link this MSDU aggregator is associated with

Definition at line 60 of file msdu-aggregator.cc.

References ns3::DynamicCast(), m_htFem, m_linkId, m_mac, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetWifiMac()

void ns3::MsduAggregator::SetWifiMac ( const Ptr< WifiMac > mac )

Set the MAC layer to use.

Parameters

mac	the MAC layer to use

Definition at line 52 of file msdu-aggregator.cc.

References ns3::DynamicCast(), m_htFem, m_linkId, m_mac, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_htFem

Ptr<HtFrameExchangeManager> ns3::MsduAggregator::m_htFem

private

the HT Frame Exchange Manager of this station

Definition at line 146 of file msdu-aggregator.h.

Referenced by DoDispose(), GetNextAmsdu(), SetLinkId(), and SetWifiMac().

◆ m_linkId

uint8_t ns3::MsduAggregator::m_linkId {0}

private

ID of the link this object is connected to.

Definition at line 147 of file msdu-aggregator.h.

Referenced by GetMaxAmsduSize(), SetLinkId(), and SetWifiMac().

◆ m_mac

Ptr<WifiMac> ns3::MsduAggregator::m_mac

private

the MAC of this station

Definition at line 145 of file msdu-aggregator.h.

Referenced by DoDispose(), GetMaxAmsduSize(), GetNextAmsdu(), SetLinkId(), and SetWifiMac().

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

src/wifi/model/msdu-aggregator.h
src/wifi/model/msdu-aggregator.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EdcaQueues

Constructor & Destructor Documentation

◆ MsduAggregator()

◆ ~MsduAggregator()

Member Function Documentation

◆ CalculatePadding()

◆ Deaggregate()

◆ DoDispose()

◆ GetMaxAmsduSize()

◆ GetNextAmsdu()

◆ GetSizeIfAggregated()

◆ GetTypeId()

◆ SetLinkId()

◆ SetWifiMac()

Member Data Documentation

◆ m_htFem

◆ m_linkId

◆ m_mac