A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::WifiDefaultGcrManager Class Reference

WifiDefaultGcrManager is the default implementation for groupcast with retries GCR, as defined in 802.11aa. More...

#include "wifi-default-gcr-manager.h"

+ Inheritance diagram for ns3::WifiDefaultGcrManager:
+ Collaboration diagram for ns3::WifiDefaultGcrManager:

Public Member Functions

 WifiDefaultGcrManager ()
 
 ~WifiDefaultGcrManager () override
 
Mac48Address GetIndividuallyAddressedRecipient (const Mac48Address &groupcastAddress) const override
 Get the MAC address of the individually addressed recipient to use for a groupcast frame or for a protection frame sent prior to groupcast frames for a given group address.
 
- Public Member Functions inherited from ns3::GcrManager
 GcrManager ()
 
 ~GcrManager () override
 
const Mac48AddressGetGcrConcealmentAddress () const
 Get the GCR concealment address.
 
const GcrMembersGetMemberStasForGroupAddress (const Mac48Address &groupAddress) const
 Get the list of MAC addresses of member STAs for a given group address.
 
GroupAddressRetransmissionPolicy GetRetransmissionPolicy () const
 Get the configured retransmission policy.
 
GroupAddressRetransmissionPolicy GetRetransmissionPolicyFor (const WifiMacHeader &header) const
 Get the retransmission policy to use to transmit a given group addressed packet.
 
bool KeepGroupcastQueued (Ptr< WifiMpdu > mpdu)
 This function indicates whether a groupcast MPDU should be kept for next retransmission.
 
void NotifyGroupMembershipChanged (const Mac48Address &staAddress, const std::set< Mac48Address > &groupAddressList)
 This function adds a STA as a member of zero or more group addresses.
 
void NotifyStaAssociated (const Mac48Address &staAddress, bool isGcrCapable)
 This function notifies a STA is associated.
 
void NotifyStaDeassociated (const Mac48Address &staAddress)
 This function deletes a STA as a member of any group addresses.
 
void SetGcrConcealmentAddress (const Mac48Address &address)
 Set the GCR concealment address.
 
void SetWifiMac (Ptr< ApWifiMac > mac)
 Set the wifi MAC.
 
bool UseConcealment (const WifiMacHeader &header) const
 Indicate whether a group addressed packet should be transmitted to the GCR concealment address.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::GcrManager
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Additional Inherited Members

- Public Types inherited from ns3::GcrManager
using GcrMembers = std::unordered_set<Mac48Address, WifiAddressHash>
 MAC addresses of member STAs of a GCR group.
 
- Protected Types inherited from ns3::GcrManager
using NonGcrStas = GcrMembers
 List of associated STAs that are not GCR capable.
 
- Protected Member Functions inherited from ns3::GcrManager
void DoDispose () override
 Destructor implementation.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Protected Attributes inherited from ns3::GcrManager
Ptr< ApWifiMacm_apMac
 the MAC of the AP
 
Mac48Address m_gcrConcealmentAddress
 GCR concealment address.
 
GroupcastProtectionMode m_gcrProtectionMode
 Protection mode for groupcast frames.
 
uint8_t m_gcrUnsolicitedRetryLimit
 GCR Unsolicited Retry Limit.
 
Ptr< WifiMpdum_mpdu
 current MPDU being retransmitted
 
NonGcrStas m_nonGcrStas
 the list of non-GCR capable STAs
 
GroupAddressRetransmissionPolicy m_retransmissionPolicy
 retransmission policy
 
GcrMembers m_staMembers
 the list of STA members (assume currently each member is part of all group)
 
uint8_t m_unsolicitedRetryCounter
 the unsolicited retry counter
 

Detailed Description

WifiDefaultGcrManager is the default implementation for groupcast with retries GCR, as defined in 802.11aa.

Since the standard does not describe how to map GCR-capable STAs to a given GCR group, the default implementation assumes all GCR-capable STAs are part of all GCR groups. Also, it is left left open to implementation which individual address to use to use while protecting a GCR transmission. The default implementation decides to pick the address of the first associated GCR-capable STA.

Definition at line 27 of file wifi-default-gcr-manager.h.

Constructor & Destructor Documentation

◆ WifiDefaultGcrManager()

ns3::WifiDefaultGcrManager::WifiDefaultGcrManager ( )

Definition at line 32 of file wifi-default-gcr-manager.cc.

References NS_LOG_FUNCTION.

◆ ~WifiDefaultGcrManager()

ns3::WifiDefaultGcrManager::~WifiDefaultGcrManager ( )
override

Definition at line 37 of file wifi-default-gcr-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetIndividuallyAddressedRecipient()

Mac48Address ns3::WifiDefaultGcrManager::GetIndividuallyAddressedRecipient ( const Mac48Address & groupAddress) const
overridevirtual

Get the MAC address of the individually addressed recipient to use for a groupcast frame or for a protection frame sent prior to groupcast frames for a given group address.

Parameters
groupAddressthe group address
Returns
the MAC address of the individually addressed recipient to use.

Implements ns3::GcrManager.

Definition at line 43 of file wifi-default-gcr-manager.cc.

References ns3::GcrManager::m_staMembers, and NS_ASSERT.

◆ GetTypeId()

TypeId ns3::WifiDefaultGcrManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 23 of file wifi-default-gcr-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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