A Discrete-Event Network Simulator
API
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::MsduAggregator Class Reference

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

#include "msdu-aggregator.h"

+ Inheritance 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...
 

Public Member Functions

 MsduAggregator ()
 
virtual ~MsduAggregator ()
 
bool Aggregate (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket, Mac48Address src, Mac48Address dest) const
 Adds packet to aggregatedPacket. More...
 
uint16_t GetMaxAmsduSize (void) const
 Returns the maximum A-MSDU size in bytes. More...
 
void SetMaxAmsduSize (uint16_t maxSize)
 Sets the maximum A-MSDU 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 DeaggregatedMsdus Deaggregate (Ptr< Packet > aggregatedPacket)
 
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
 Calculates how much padding must be added to the end of aggregated packet, after that a new packet is added. More...
 

Private Attributes

uint16_t m_maxAmsduLength
 maximum AMSDU length 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 32 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ DeaggregatedMsdus

DeaggregatedMsdus typedef.

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

◆ DeaggregatedMsdusCI

DeaggregatedMsdusCI typedef.

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

Constructor & Destructor Documentation

◆ MsduAggregator()

ns3::MsduAggregator::MsduAggregator ( )

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

◆ ~MsduAggregator()

ns3::MsduAggregator::~MsduAggregator ( )
virtual

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

Member Function Documentation

◆ Aggregate()

bool ns3::MsduAggregator::Aggregate ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket,
Mac48Address  src,
Mac48Address  dest 
) const

Adds packet to aggregatedPacket.

In concrete aggregator's implementation is specified how and if packet can be added to aggregatedPacket. If packet can be added returns true, false otherwise.

Parameters
packetthe packet.
aggregatedPacketthe aggregated packet.
srcthe source address.
destthe destination address
Returns
true if successful.

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

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

Referenced by ns3::QosTxop::NotifyAccessGranted().

◆ CalculatePadding()

uint8_t ns3::MsduAggregator::CalculatePadding ( Ptr< const Packet packet) const
private

Calculates how much padding must be added to the end of aggregated packet, after that a new packet is added.

Each A-MSDU subframe is padded so that its length is multiple of 4 octets.

Parameters
packet
Returns
the number of octets required for padding

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

References ns3::Packet::GetSize().

Referenced by Aggregate().

◆ Deaggregate()

MsduAggregator::DeaggregatedMsdus ns3::MsduAggregator::Deaggregate ( Ptr< Packet aggregatedPacket)
static

◆ GetMaxAmsduSize()

uint16_t ns3::MsduAggregator::GetMaxAmsduSize ( void  ) const

Returns the maximum A-MSDU size in bytes.

Value 0 means that MSDU aggregation is disabled.

Returns
the maximum A-MSDU size in bytes.

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

References m_maxAmsduLength.

Referenced by Aggregate().

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

◆ SetMaxAmsduSize()

void ns3::MsduAggregator::SetMaxAmsduSize ( uint16_t  maxSize)

Sets the maximum A-MSDU size in bytes.

Value 0 means that MSDU aggregation is disabled.

Parameters
maxSizethe maximum A-MSDU size in bytes.

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

References m_maxAmsduLength.

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

Member Data Documentation

◆ m_maxAmsduLength

uint16_t ns3::MsduAggregator::m_maxAmsduLength
private

maximum AMSDU length

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

Referenced by GetMaxAmsduSize(), and SetMaxAmsduSize().


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