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

Standard MSDU aggregator. More...

#include "msdu-standard-aggregator.h"

+ Inheritance diagram for ns3::MsduStandardAggregator:
+ Collaboration diagram for ns3::MsduStandardAggregator:

Public Member Functions

 MsduStandardAggregator ()
 
 ~MsduStandardAggregator ()
 
bool Aggregate (Ptr< const Packet > packet, Ptr< Packet > aggregatedPacket, Mac48Address src, Mac48Address dest) const
 
uint32_t GetMaxAmsduSize (void) const
 Returns the maximum A-MSDU size in bytes. More...
 
void SetMaxAmsduSize (uint32_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 TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::MsduAggregator
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

uint32_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

uint32_t m_maxAmsduLength
 maximum AMSDU length More...
 

Additional Inherited Members

- Public Types inherited from ns3::MsduAggregator
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...
 
- 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 MSDU aggregator.

Introspection did not find any typical Config paths.


Attributes

  • MaxAmsduSize: Max length in byte of an A-MSDU (Deprecated!)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 7935
    • 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 msdu-standard-aggregator.h.

Constructor & Destructor Documentation

ns3::MsduStandardAggregator::MsduStandardAggregator ( )

Definition at line 46 of file msdu-standard-aggregator.cc.

ns3::MsduStandardAggregator::~MsduStandardAggregator ( )

Definition at line 50 of file msdu-standard-aggregator.cc.

Member Function Documentation

bool ns3::MsduStandardAggregator::Aggregate ( Ptr< const Packet packet,
Ptr< Packet aggregatedPacket,
Mac48Address  src,
Mac48Address  dest 
) const
virtual
Parameters
packetPacket we have to insert into aggregatedPacket.
aggregatedPacketPacket that will contain packet, if aggregation is possible,
srcSource address of packet.
destDestination address of packet.
Returns
true if the packet can be aggregated, false otherwise

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

Implements ns3::MsduAggregator.

Definition at line 67 of file msdu-standard-aggregator.cc.

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

+ Here is the call graph for this function:

uint32_t ns3::MsduStandardAggregator::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 97 of file msdu-standard-aggregator.cc.

References ns3::Packet::GetSize().

Referenced by Aggregate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::MsduStandardAggregator::GetMaxAmsduSize ( void  ) const
virtual

Returns the maximum A-MSDU size in bytes.

Value 0 means that MSDU aggregation is disabled.

Returns
the maximum A-MSDU size in bytes.

Implements ns3::MsduAggregator.

Definition at line 61 of file msdu-standard-aggregator.cc.

References m_maxAmsduLength.

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

Get the type ID.

Returns
the object TypeId

Definition at line 32 of file msdu-standard-aggregator.cc.

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

+ Here is the call graph for this function:

void ns3::MsduStandardAggregator::SetMaxAmsduSize ( uint32_t  maxSize)
virtual

Sets the maximum A-MSDU size in bytes.

Value 0 means that MSDU aggregation is disabled.

Parameters
maxSizethe maximum A-MSDU size in bytes.

Implements ns3::MsduAggregator.

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

References m_maxAmsduLength.

Member Data Documentation

uint32_t ns3::MsduStandardAggregator::m_maxAmsduLength
private

maximum AMSDU length

Definition at line 85 of file msdu-standard-aggregator.h.

Referenced by Aggregate(), GetMaxAmsduSize(), GetTypeId(), and SetMaxAmsduSize().


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