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::list< std::pair< Ptr< Packet >, AmsduSubframeHeader > > DeaggregatedMsdus
 DeaggregatedMsdus typedef. More...
 
typedef std::list< std::pair< Ptr< Packet >, AmsduSubframeHeader > >::const_iterator DeaggregatedMsdusCI
 DeaggregatedMsdusCI typedef. More...
 
typedef std::map< AcIndex, Ptr< QosTxop > > EdcaQueues
 EDCA queues typedef. More...
 

Public Member Functions

 MsduAggregator ()
 
virtual ~MsduAggregator ()
 
void Aggregate (Ptr< const Packet > msdu, Ptr< Packet > amsdu, Mac48Address src, Mac48Address dest) const
 Aggregate an MSDU to an A-MSDU. More...
 
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 (Mac48Address recipient, uint8_t tid, WifiTxVector txVector, uint32_t ampduSize=0, Time ppduDurationLimit=Seconds(0)) const
 Dequeue MSDUs to be transmitted to a given station and belonging to a given TID from the corresponding EDCA queue and aggregate them to form an A-MSDU that meets the following constraints: More...
 
void SetEdcaQueues (EdcaQueues map)
 Set the map of EDCA queues. 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...
 
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 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...
 

Static Private 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...
 

Private Attributes

EdcaQueues m_edca
 the map of EDCA queues 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...
 

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 80 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ DeaggregatedMsdus

DeaggregatedMsdus typedef.

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

◆ DeaggregatedMsdusCI

DeaggregatedMsdusCI typedef.

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

◆ EdcaQueues

EDCA queues typedef.

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

Constructor & Destructor Documentation

◆ MsduAggregator()

ns3::MsduAggregator::MsduAggregator ( )

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

◆ ~MsduAggregator()

ns3::MsduAggregator::~MsduAggregator ( )
virtual

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

Member Function Documentation

◆ Aggregate()

void ns3::MsduAggregator::Aggregate ( Ptr< const Packet msdu,
Ptr< Packet amsdu,
Mac48Address  src,
Mac48Address  dest 
) const

Aggregate an MSDU to an A-MSDU.

Parameters
msduthe MSDU.
amsduthe A-MSDU.
srcthe source address.
destthe destination address

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

References ns3::Packet::AddAtEnd(), ns3::Packet::AddHeader(), CalculatePadding(), ns3::Packet::Copy(), ns3::Packet::GetSize(), NS_ASSERT, NS_LOG_FUNCTION, ns3::AmsduSubframeHeader::SetDestinationAddr(), ns3::AmsduSubframeHeader::SetLength(), and ns3::AmsduSubframeHeader::SetSourceAddr().

Referenced by GetNextAmsdu().

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

◆ CalculatePadding()

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

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 224 of file msdu-aggregator.cc.

Referenced by Aggregate(), and GetSizeIfAggregated().

+ Here is the caller graph for this function:

◆ Deaggregate()

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

Definition at line 318 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::ApWifiMac::DeaggregateAmsduAndForward(), and ns3::RegularWifiMac::DeaggregateAmsduAndForward().

+ Here is the call graph for this function:
+ Here is the caller 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.

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

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, ns3::UintegerValue::Get(), ns3::Txop::GetLow(), ns3::WifiNetDevice::GetMac(), ns3::WifiNetDevice::GetRemoteStationManager(), ns3::WifiRemoteStationManager::GetStationHtCapabilities(), ns3::WifiRemoteStationManager::GetStationVhtCapabilities(), m_edca, 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 ( Mac48Address  recipient,
uint8_t  tid,
WifiTxVector  txVector,
uint32_t  ampduSize = 0,
Time  ppduDurationLimit = Seconds (0) 
) const

Dequeue MSDUs to be transmitted to a given station and belonging to a given TID from the corresponding EDCA queue and aggregate them to form an A-MSDU that meets 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 an existing A-MPDU of the given size (possibly null) 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 both the maximum PPDU duration allowed by the corresponding modulation class (if any) and the given PPDU duration limit (if non null)

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
recipientthe receiver station address.
tidthe TID.
txVectorthe TxVector used to transmit the frame
ampduSizethe size of the existing A-MPDU
ppduDurationLimitthe limit on the PPDU duration
Returns
the resulting A-MSDU, if aggregation is possible, 0 otherwise.

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

References Aggregate(), GetMaxAmsduSize(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::Packet::GetSize(), ns3::WifiMacHeader::GetSize(), GetSizeIfAggregated(), ns3::Mac48Address::IsBroadcast(), m_edca, ns3::Max(), NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetQosAmsdu(), and ns3::WIFI_MAC_FCS_LENGTH.

+ 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.
amsduSizethe A-MSDU size.
Returns
the size of the resulting A-MSDU.

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

References CalculatePadding(), and NS_LOG_FUNCTION.

Referenced by GetNextAmsdu().

+ 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 45 of file msdu-aggregator.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetEdcaQueues()

void ns3::MsduAggregator::SetEdcaQueues ( EdcaQueues  map)

Set the map of EDCA queues.

Parameters
mapthe map of EDCA queues.

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

References m_edca.

Member Data Documentation

◆ m_edca

EdcaQueues ns3::MsduAggregator::m_edca
private

the map of EDCA queues

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

Referenced by GetMaxAmsduSize(), GetNextAmsdu(), and SetEdcaQueues().


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