A Discrete-Event Network Simulator
API
ns3::MsduAggregator Class Reference

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

Public Member Functions

 MsduAggregator ()
 
virtual ~MsduAggregator ()
 
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. More...
 
Ptr< WifiMacQueueItemGetNextAmsdu (Ptr< const WifiMacQueueItem > peekedItem, WifiTxParameters &txParams, Time availableTime, WifiMacQueueItem::QueueIteratorPair &queueIt) const
 Attempt to aggregate other MSDUs to the given A-MSDU while meeting the following constraints: More...
 
void SetWifiMac (const Ptr< RegularWifiMac > mac)
 Set the MAC layer to use. 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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 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. More...
 
static WifiMacQueueItem::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. More...
 
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...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Attributes

Ptr< HtFrameExchangeManagerm_htFem
 the HT Frame Exchange Manager of this station More...
 
Ptr< RegularWifiMacm_mac
 the MAC of this station More...
 

Additional Inherited Members

Detailed Description

Aggregator used to construct A-MSDUs.


Introspection did not find any typical Config paths.


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

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

Member Typedef Documentation

◆ EdcaQueues

EDCA queues typedef.

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

Constructor & Destructor Documentation

◆ MsduAggregator()

ns3::MsduAggregator::MsduAggregator ( )

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

◆ ~MsduAggregator()

ns3::MsduAggregator::~MsduAggregator ( )
virtual

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

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
amsduSizethe size of the A-MSDU
Returns
the number of octets required for padding

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

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

+ Here is the caller graph for this function:

◆ Deaggregate()

WifiMacQueueItem::DeaggregatedMsdus ns3::MsduAggregator::Deaggregate ( Ptr< Packet aggregatedPacket)
static
Parameters
aggregatedPacketthe aggregated packet.
Returns
DeaggregatedMsdus.

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

References ns3::Packet::CreateFragment(), ns3::AmsduSubframeHeader::GetLength(), ns3::Packet::GetSize(), NS_LOG_FUNCTION_NOARGS, NS_LOG_INFO, ns3::Packet::RemoveAtStart(), and ns3::Packet::RemoveHeader().

Referenced by ns3::WifiMacQueueItem::WifiMacQueueItem().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::MsduAggregator::DoDispose ( void  )
protectedvirtual

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 61 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
recipientthe receiver station address.
tidthe TID.
modulationthe modulation class.
Returns
the maximum A-MSDU size in bytes.

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

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, ns3::UintegerValue::Get(), ns3::WifiRemoteStationManager::GetStationHtCapabilities(), ns3::WifiRemoteStationManager::GetStationVhtCapabilities(), m_mac, min, NS_ABORT_MSG, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by GetNextAmsdu().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetNextAmsdu()

Ptr< WifiMacQueueItem > ns3::MsduAggregator::GetNextAmsdu ( Ptr< const WifiMacQueueItem peekedItem,
WifiTxParameters txParams,
Time  availableTime,
WifiMacQueueItem::QueueIteratorPair queueIt 
) 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 it is not possible to aggregate at least two MSDUs, no MSDU is dequeued from the EDCA queue and a null pointer is returned.

Parameters
peekedItemthe MSDU which we attempt to aggregate other MSDUs to
txParamsthe TX parameters for the current frame
availableTimethe time available for the frame exchange
[out]queueIta QueueIteratorPair pointing to the queue item following the last item used to prepare the returned A-MSDU, if any; otherwise, its value is unchanged
Returns
the resulting A-MSDU, if aggregation is possible, a null pointer otherwise.

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

References ns3::WifiMacQueueItem::Aggregate(), ns3::Copy(), GetMaxAmsduSize(), ns3::WifiTxVector::GetModulationClass(), ns3::Mac48Address::IsBroadcast(), m_htFem, ns3::WifiTxParameters::m_txVector, NS_ABORT_MSG_IF, NS_ASSERT, 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
msduSizethe MSDU size in bytes.
amsduSizethe A-MSDU size in bytes.
Returns
the size of the resulting A-MSDU in bytes.

Definition at line 77 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 ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetWifiMac()

void ns3::MsduAggregator::SetWifiMac ( const Ptr< RegularWifiMac mac)

Set the MAC layer to use.

Parameters
macthe MAC layer to use

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

References m_htFem, m_mac, third::mac, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_htFem

Ptr<HtFrameExchangeManager> ns3::MsduAggregator::m_htFem
private

the HT Frame Exchange Manager of this station

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

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

◆ m_mac

Ptr<RegularWifiMac> ns3::MsduAggregator::m_mac
private

the MAC of this station

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

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


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