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

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::list< std::pair< Ptr< Packet >, AmpduSubframeHeader > > DeaggregatedMpdus
 A list of deaggregated packets and their A-MPDU subframe headers. More...
 
typedef std::list< std::pair< Ptr< Packet >, AmpduSubframeHeader > >::const_iterator DeaggregatedMpdusCI
 A constant iterator for a list of deaggregated packets and their A-MPDU subframe headers. More...
 

Public Member Functions

 MpduAggregator ()
 
virtual ~MpduAggregator ()
 
void AddHeaderAndPad (Ptr< Packet > packet, bool last, bool isSingleMpdu) const
 
bool Aggregate (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket) const
 
void AggregateSingleMpdu (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket) const
 
bool CanBeAggregated (uint32_t packetSize, Ptr< Packet > aggregatedPacket, uint8_t blockAckSize) const
 
uint16_t GetMaxAmpduSize (void) const
 Returns the maximum A-MPDU size in bytes. More...
 
void SetMaxAmpduSize (uint16_t maxSize)
 Sets the maximum A-MPDU size in bytes. 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 DeaggregatedMpdus Deaggregate (Ptr< Packet > aggregatedPacket)
 Deaggregates an A-MPDU by removing the A-MPDU subframe header and padding. 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...
 

Private Member Functions

uint8_t CalculatePadding (Ptr< const Packet > packet) const
 

Private Attributes

uint16_t m_maxAmpduLength
 Maximum length in bytes of A-MPDUs. 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-MPDUs.

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

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

Member Typedef Documentation

A list of deaggregated packets and their A-MPDU subframe headers.

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

A constant iterator for a list of deaggregated packets and their A-MPDU subframe headers.

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

Constructor & Destructor Documentation

ns3::MpduAggregator::MpduAggregator ( )

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

ns3::MpduAggregator::~MpduAggregator ( )
virtual

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

Member Function Documentation

void ns3::MpduAggregator::AddHeaderAndPad ( Ptr< Packet packet,
bool  last,
bool  isSingleMpdu 
) const
Parameters
packetthe packet we want to insert into aggregatedPacket.
lasttrue if it is the last packet.
isSingleMpdutrue if it is a single MPDU

Adds A-MPDU subframe header and padding to each MPDU that is part of an A-MPDU before it is sent.

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

References ns3::Packet::AddAtEnd(), ns3::Packet::AddHeader(), CalculatePadding(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, ns3::AmpduSubframeHeader::SetEof(), and ns3::AmpduSubframeHeader::SetLength().

+ Here is the call graph for this function:

bool ns3::MpduAggregator::Aggregate ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket 
) const
Parameters
packetPacket we have to insert into aggregatedPacket.
aggregatedPacketPacket that will contain packet, if aggregation is possible.
Returns
true if packet can be aggregated to aggregatedPacket, false otherwise.

Adds packet to aggregatedPacket. In concrete aggregator's implementation is specified how and if packet can be added to aggregatedPacket.

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

References ns3::Packet::AddAtEnd(), ns3::Packet::AddHeader(), CalculatePadding(), ns3::Packet::Copy(), GetMaxAmpduSize(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, and ns3::AmpduSubframeHeader::SetLength().

+ Here is the call graph for this function:

void ns3::MpduAggregator::AggregateSingleMpdu ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket 
) const
Parameters
packetthe packet we want to insert into aggregatedPacket.
aggregatedPacketpacket that will contain the packet of size packetSize, if aggregation is possible.

This method performs a VHT/HE single MPDU aggregation.

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

References ns3::Packet::AddAtEnd(), ns3::Packet::AddHeader(), CalculatePadding(), ns3::Packet::Copy(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, ns3::AmpduSubframeHeader::SetEof(), and ns3::AmpduSubframeHeader::SetLength().

+ Here is the call graph for this function:

uint8_t ns3::MpduAggregator::CalculatePadding ( Ptr< const Packet packet) const
private
Parameters
packetthe Packet
Returns
padding that must be added to the end of an aggregated packet

Calculates how much padding must be added to the end of an aggregated packet, after that a new packet is added. Each A-MPDU subframe is padded so that its length is multiple of 4 octets.

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

References ns3::Packet::GetSize().

Referenced by AddHeaderAndPad(), Aggregate(), AggregateSingleMpdu(), and CanBeAggregated().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::MpduAggregator::CanBeAggregated ( uint32_t  packetSize,
Ptr< Packet aggregatedPacket,
uint8_t  blockAckSize 
) const
Parameters
packetSizesize of the packet we want to insert into aggregatedPacket.
aggregatedPacketpacket that will contain the packet of size packetSize, if aggregation is possible.
blockAckSizesize of the piggybacked block ack request
Returns
true if the packet of size packetSize can be aggregated to aggregatedPacket, false otherwise.

This method is used to determine if a packet could be aggregated to an A-MPDU without exceeding the maximum packet size.

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

References CalculatePadding(), GetMaxAmpduSize(), and ns3::Packet::GetSize().

+ Here is the call graph for this function:

MpduAggregator::DeaggregatedMpdus ns3::MpduAggregator::Deaggregate ( Ptr< Packet aggregatedPacket)
static

Deaggregates an A-MPDU by removing the A-MPDU subframe header and padding.

Parameters
aggregatedPacketthe aggregated packet
Returns
list of deaggragted packets and their A-MPDU subframe headers

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

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

Referenced by ns3::MacLow::DeaggregateAmpduAndReceive().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint16_t ns3::MpduAggregator::GetMaxAmpduSize ( void  ) const

Returns the maximum A-MPDU size in bytes.

Value 0 means that MPDU aggregation is disabled.

Returns
the maximum A-MPDU size in bytes.

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

References m_maxAmpduLength.

Referenced by Aggregate(), CanBeAggregated(), ns3::QosTxop::NeedFragmentation(), ns3::QosTxop::SetupBlockAckIfNeeded(), and ns3::QosTxop::VerifyBlockAck().

+ Here is the caller graph for this function:

TypeId ns3::MpduAggregator::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::MpduAggregator::SetMaxAmpduSize ( uint16_t  maxSize)

Sets the maximum A-MPDU size in bytes.

Value 0 means that MPDU aggregation is disabled.

Parameters
maxSizethe maximum A-MPDU size in bytes.

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

References m_maxAmpduLength.

Referenced by ns3::RegularWifiMac::ConfigureAggregation(), AmpduAggregationTest::DoRun(), and TwoLevelAggregationTest::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::MpduAggregator::m_maxAmpduLength
private

Maximum length in bytes of A-MPDUs.

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

Referenced by GetMaxAmpduSize(), and SetMaxAmpduSize().


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