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 Mac48Address &	GetGcrConcealmentAddress () const
	Get the GCR concealment address.

const GcrMembers &	GetMemberStasForGroupAddress (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 final
	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< Object >	GetObject () 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< Object >	GetObject (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.

SimpleRefCount &	operator= (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< ApWifiMac >	m_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< WifiMpdu >	m_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

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.

Config Paths

ns3::WifiDefaultGcrManager is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::ApWifiMac/GcrManager/$ns3::WifiDefaultGcrManager"

No Attributes are defined for this type.

Attributes defined in parent class ns3::GcrManager

GcrConcealmentAddress: The GCR concealment address.
- Set with class: ns3::Mac48AddressValue
- Underlying type: Mac48Address
- Initial value: 01:0f:ac:47:43:52
- Flags: constructwriteread
- Support level: SUPPORTED
GcrProtectionMode: Protection mode used for groupcast frames when needed: Rts-Cts or Cts-To-Self
- Set with class: ns3::EnumValue<ns3::GroupcastProtectionMode>
- Underlying type: Rts-Cts|Cts-To-Self
- Initial value: Rts-Cts
- Flags: constructwriteread
- Support level: SUPPORTED
RetransmissionPolicy: The retransmission policy to use for group addresses.
- Set with class: ns3::EnumValue<ns3::GroupAddressRetransmissionPolicy>
- Underlying type: NO_RETRY|GCR_UR|GCR_BA
- Initial value: NO_RETRY
- Flags: constructread
- Support level: SUPPORTED
UnsolicitedRetryLimit: The maximum number of transmission attempts of a frame delivered using the GCR unsolicited retry retransmission policy.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 7
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Wifi

Size of this type is 200 bytes (on a 64-bit architecture).

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

groupAddress the group address