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

#include "mpdu-aggregator.h"

Inheritance diagram for ns3::MpduAggregator:

Collaboration diagram for ns3::MpduAggregator:

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

Public Member Functions
	MpduAggregator ()=default

	~MpduAggregator () override=default

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

std::vector< Ptr< WifiMpdu > >	GetNextAmpdu (Ptr< WifiMpdu > mpdu, WifiTxParameters &txParams, Time availableTime) const
	Attempt to aggregate other MPDUs to the given MPDU, while meeting the following constraints:

void	SetLinkId (uint8_t linkId)
	Set the ID of the link this MPDU 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 void	Aggregate (Ptr< const WifiMpdu > mpdu, Ptr< Packet > ampdu, bool isSingle)
	Aggregate an MPDU to an A-MPDU.

static uint8_t	CalculatePadding (uint32_t ampduSize)

static AmpduSubframeHeader	GetAmpduSubframeHeader (uint16_t mpduSize, bool isSingle)
	Get the A-MPDU subframe header corresponding to the MPDU size and whether the MPDU is a single MPDU.

static uint32_t	GetSizeIfAggregated (uint32_t mpduSize, uint32_t ampduSize)
	Compute the size of the A-MPDU resulting from the aggregation of an MPDU of size mpduSize and an A-MPDU of size ampduSize.

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-MPDUs.

Definition at line 36 of file mpdu-aggregator.h.

Member Typedef Documentation

◆ EdcaQueues

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

EDCA queues typedef.

Definition at line 42 of file mpdu-aggregator.h.

Constructor & Destructor Documentation

◆ MpduAggregator()

ns3::MpduAggregator::MpduAggregator ( )

default

◆ ~MpduAggregator()

ns3::MpduAggregator::~MpduAggregator ( )

overridedefault

Member Function Documentation

◆ Aggregate()

void ns3::MpduAggregator::Aggregate	(	Ptr< const WifiMpdu >	mpdu,
		Ptr< Packet >	ampdu,
		bool	isSingle )

static

Aggregate an MPDU to an A-MPDU.

Parameters

mpdu	the MPDU.
ampdu	the A-MPDU.
isSingle	whether it is a single MPDU.

Definition at line 78 of file mpdu-aggregator.cc.

References ns3::AddWifiMacTrailer(), CalculatePadding(), ns3::Create(), GetAmpduSubframeHeader(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::WifiPsdu::GetPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculatePadding()

uint8_t ns3::MpduAggregator::CalculatePadding ( uint32_t ampduSize )

static

Parameters

ampduSize the size of the A-MPDU that needs to be padded in bytes

Returns: the size of the padding that must be added to the end of an A-MPDU in bytes

Calculates how much padding must be added to the end of an A-MPDU of the given size (once another MPDU is aggregated). Each A-MPDU subframe is padded so that its length is multiple of 4 octets.

Definition at line 187 of file mpdu-aggregator.cc.

Referenced by Aggregate(), ns3::WifiPsdu::GetAmpduSubframeSize(), and GetSizeIfAggregated().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::MpduAggregator::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 51 of file mpdu-aggregator.cc.

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

Here is the call graph for this function:

◆ GetAmpduSubframeHeader()

AmpduSubframeHeader ns3::MpduAggregator::GetAmpduSubframeHeader	(	uint16_t	mpduSize,
		bool	isSingle )

static

Get the A-MPDU subframe header corresponding to the MPDU size and whether the MPDU is a single MPDU.

Parameters

mpduSize	size of the MPDU in bytes.
isSingle	true if S-MPDU.

Returns: the A-MPDU subframe header

Definition at line 193 of file mpdu-aggregator.cc.

References ns3::AmpduSubframeHeader::SetEof(), and ns3::AmpduSubframeHeader::SetLength().

Referenced by Aggregate(), and ns3::WifiPsdu::GetAmpduSubframe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaxAmpduSize()

uint32_t ns3::MpduAggregator::GetMaxAmpduSize	(	Mac48Address	recipient,
		uint8_t	tid,
		WifiModulationClass	modulation ) const

Determine the maximum size for an A-MPDU 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-MPDU size in bytes.

Definition at line 119 of file mpdu-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, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by GetNextAmpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNextAmpdu()

std::vector< Ptr< WifiMpdu > > ns3::MpduAggregator::GetNextAmpdu	(	Ptr< WifiMpdu >	mpdu,
		WifiTxParameters &	txParams,
		Time	availableTime ) const

Attempt to aggregate other MPDUs to the given MPDU, while meeting the following constraints:

the size of the resulting A-MPDU 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 ())

For now, only non-broadcast QoS Data frames can be aggregated (do not pass other types of frames to this method). MPDUs to aggregate are looked for among those with the same TID and receiver as the given MPDU.

The resulting A-MPDU is returned as a vector of the constituent MPDUs (including the given MPDU), which are not actually aggregated (call the Aggregate method afterwards to get the actual A-MPDU). If aggregation was not possible (aggregation is disabled, there is no Block Ack agreement established with the receiver, or another MPDU to aggregate was not found), the returned vector is empty.

Parameters

mpdu	the given MPDU.
txParams	the TX parameters used to transmit the frame
availableTime	the time available for the frame exchange

Returns: the resulting A-MPDU, if aggregation is possible.

Definition at line 205 of file mpdu-aggregator.cc.

References GetMaxAmpduSize(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxParameters::GetSize(), ns3::Mac48Address::IsBroadcast(), ns3::IsInWindow(), m_htFem, m_linkId, m_mac, ns3::WifiTxParameters::m_txVector, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetSizeIfAggregated()

uint32_t ns3::MpduAggregator::GetSizeIfAggregated	(	uint32_t	mpduSize,
		uint32_t	ampduSize )

static

Compute the size of the A-MPDU resulting from the aggregation of an MPDU of size mpduSize and an A-MPDU of size ampduSize.

Parameters

mpduSize	the MPDU size in bytes.
ampduSize	the A-MPDU size in bytes.

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

Definition at line 111 of file mpdu-aggregator.cc.

References CalculatePadding(), and NS_LOG_FUNCTION.

Referenced by ns3::WifiPsdu::WifiPsdu(), ns3::WifiTxParameters::AddMpdu(), ns3::MultiUserScheduler::GetMaxSizeOfQosNullAmpdu(), ns3::VhtFrameExchangeManager::GetPsduSize(), ns3::WifiTxParameters::GetSize(), and ns3::WifiTxParameters::GetSizeIfAddMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MpduAggregator::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 41 of file mpdu-aggregator.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetLinkId()

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

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

Parameters

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

Definition at line 67 of file mpdu-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::MpduAggregator::SetWifiMac ( const Ptr< WifiMac > mac )

Set the MAC layer to use.

Parameters

mac	the MAC layer to use

Definition at line 59 of file mpdu-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::MpduAggregator::m_htFem

private

the HT Frame Exchange Manager of this station

Definition at line 159 of file mpdu-aggregator.h.

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

◆ m_linkId

uint8_t ns3::MpduAggregator::m_linkId {0}

private

ID of the link this object is connected to.

Definition at line 160 of file mpdu-aggregator.h.

Referenced by GetMaxAmpduSize(), GetNextAmpdu(), SetLinkId(), and SetWifiMac().

◆ m_mac

Ptr<WifiMac> ns3::MpduAggregator::m_mac

private

the MAC of this station

Definition at line 158 of file mpdu-aggregator.h.

Referenced by DoDispose(), GetMaxAmpduSize(), GetNextAmpdu(), SetLinkId(), and SetWifiMac().

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

src/wifi/model/mpdu-aggregator.h
src/wifi/model/mpdu-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

◆ MpduAggregator()

◆ ~MpduAggregator()

Member Function Documentation

◆ Aggregate()

◆ CalculatePadding()

◆ DoDispose()

◆ GetAmpduSubframeHeader()

◆ GetMaxAmpduSize()

◆ GetNextAmpdu()

◆ GetSizeIfAggregated()

◆ GetTypeId()

◆ SetLinkId()

◆ SetWifiMac()

Member Data Documentation

◆ m_htFem

◆ m_linkId

◆ m_mac