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

Standard MPDU aggregator. More...

#include "mpdu-standard-aggregator.h"

+ Inheritance diagram for ns3::MpduStandardAggregator:
+ Collaboration diagram for ns3::MpduStandardAggregator:

Public Member Functions

 MpduStandardAggregator ()
 
 ~MpduStandardAggregator ()
 
virtual void AddHeaderAndPad (Ptr< Packet > packet, bool last, bool vhtSingleMpdu)
 Adds A-MPDU subframe header and padding to each MPDU that is part of an A-MPDU before it is sent. More...
 
virtual bool Aggregate (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket)
 
virtual void AggregateVhtSingleMpdu (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket)
 This method performs a VHT single MPDU aggregation. More...
 
virtual uint32_t CalculatePadding (Ptr< const Packet > packet)
 
virtual bool CanBeAggregated (uint32_t packetSize, Ptr< Packet > aggregatedPacket, uint8_t blockAckSize)
 
virtual uint32_t GetMaxAmpduSize (void) const
 
virtual void SetMaxAmpduSize (uint32_t maxSize)
 
- 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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
 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. 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 TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::MpduAggregator
static DeaggregatedMpdus Deaggregate (Ptr< Packet > aggregatedPacket)
 Deaggregates an A-MPDU by removing the A-MPDU subframe header and padding. More...
 
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint32_t m_maxAmpduLength
 Maximum length in bytes of A-MPDUs. More...
 

Additional Inherited Members

- Public Types inherited from ns3::MpduAggregator
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...
 
- 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

Standard MPDU aggregator.

Introspection did not find any typical Config paths.


Attributes

  • MaxAmpduSize: Max length in bytes of an A-MPDU (Deprecated!)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 65535
    • Flags: construct write read

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

Definition at line 33 of file mpdu-standard-aggregator.h.

Constructor & Destructor Documentation

ns3::MpduStandardAggregator::MpduStandardAggregator ( )

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

ns3::MpduStandardAggregator::~MpduStandardAggregator ( )

Definition at line 51 of file mpdu-standard-aggregator.cc.

Member Function Documentation

void ns3::MpduStandardAggregator::AddHeaderAndPad ( Ptr< Packet packet,
bool  last,
bool  vhtSingleMpdu 
)
virtual

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

Implements ns3::MpduAggregator.

Definition at line 121 of file mpdu-standard-aggregator.cc.

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

+ Here is the call graph for this function:

bool ns3::MpduStandardAggregator::Aggregate ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket 
)
virtual
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.

This method performs an MPDU aggregation. Returns true if packet can be aggregated to aggregatedPacket, false otherwise.

Implements ns3::MpduAggregator.

Definition at line 68 of file mpdu-standard-aggregator.cc.

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

+ Here is the call graph for this function:

void ns3::MpduStandardAggregator::AggregateVhtSingleMpdu ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket 
)
virtual
uint32_t ns3::MpduStandardAggregator::CalculatePadding ( Ptr< const Packet packet)
virtual
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.

Implements ns3::MpduAggregator.

Definition at line 166 of file mpdu-standard-aggregator.cc.

References ns3::Packet::GetSize().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::MpduStandardAggregator::CanBeAggregated ( uint32_t  packetSize,
Ptr< Packet aggregatedPacket,
uint8_t  blockAckSize 
)
virtual
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.

Implements ns3::MpduAggregator.

Definition at line 147 of file mpdu-standard-aggregator.cc.

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

+ Here is the call graph for this function:

uint32_t ns3::MpduStandardAggregator::GetMaxAmpduSize ( void  ) const
virtual

Implements ns3::MpduAggregator.

Definition at line 62 of file mpdu-standard-aggregator.cc.

References m_maxAmpduLength.

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

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

References m_maxAmpduLength, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::MpduStandardAggregator::SetMaxAmpduSize ( uint32_t  maxSize)
virtual

Implements ns3::MpduAggregator.

Definition at line 56 of file mpdu-standard-aggregator.cc.

References m_maxAmpduLength.

Member Data Documentation

uint32_t ns3::MpduStandardAggregator::m_maxAmpduLength
private

Maximum length in bytes of A-MPDUs.

Definition at line 82 of file mpdu-standard-aggregator.h.

Referenced by Aggregate(), CanBeAggregated(), GetMaxAmpduSize(), GetTypeId(), and SetMaxAmpduSize().


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