Common Info field of the Basic Multi-Link element. More...

#include "multi-link-element.h"

Collaboration diagram for ns3::CommonInfoBasicMle:

Classes
struct	EmlCapabilities
	EML Capabilities subfield. More...

struct	MediumSyncDelayInfo
	Medium Synchronization Delay Information subfield. More...

struct	MldCapabilities
	MLD Capabilities subfield. More...

Public Member Functions
uint8_t	Deserialize (Buffer::Iterator start, uint16_t presence)
	Deserialize the Common Info field.

Time	GetMediumSyncDelayTimer () const
	Get the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in the Common Info field.

std::optional< uint8_t >	GetMediumSyncMaxNTxops () const
	Get the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running at a non-AP STA.

int8_t	GetMediumSyncOfdmEdThreshold () const
	Get the Medium Synchronization OFDM ED Threshold in dBm.

uint16_t	GetPresenceBitmap () const
	Get the Presence Bitmap subfield of the Common Info field.

uint8_t	GetSize () const
	Get the size of the serialized Common Info field.

void	Serialize (Buffer::Iterator &start) const
	Serialize the Common Info field.

void	SetMediumSyncDelayTimer (Time delay)
	Set the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in the Common Info field.

void	SetMediumSyncMaxNTxops (uint8_t nTxops)
	Set the Medium Synchronization Maximum Number of TXOPs subfield of the Medium Synchronization Delay Information in the Common Info field.

void	SetMediumSyncOfdmEdThreshold (int8_t threshold)
	Set the Medium Synchronization OFDM ED Threshold subfield of the Medium Synchronization Delay Information in the Common Info field.

Static Public Member Functions
static Time	DecodeEmlsrPaddingDelay (uint8_t value)

static Time	DecodeEmlsrTransitionDelay (uint8_t value)

static uint8_t	EncodeEmlsrPaddingDelay (Time delay)

static uint8_t	EncodeEmlsrTransitionDelay (Time delay)

Public Attributes
std::optional< uint8_t >	m_bssParamsChangeCount
	BSS Parameters Change Count.

std::optional< EmlCapabilities >	m_emlCapabilities
	EML Capabilities.

std::optional< uint8_t >	m_linkIdInfo
	Link ID Info.

std::optional< MediumSyncDelayInfo >	m_mediumSyncDelayInfo
	Medium Synchronization Delay Information.

std::optional< MldCapabilities >	m_mldCapabilities
	MLD Capabilities.

Mac48Address	m_mldMacAddress
	Subfields.

Detailed Description

Common Info field of the Basic Multi-Link element.

See Sec. 9.4.2.312.2.2 of 802.11be D1.5

Definition at line 35 of file multi-link-element.h.

Member Function Documentation

◆ DecodeEmlsrPaddingDelay()

Time ns3::CommonInfoBasicMle::DecodeEmlsrPaddingDelay ( uint8_t value )

static

Parameters

value the value for the EMLSR Padding Delay subfield

Returns: the corresponding EMLSR Padding delay

Definition at line 168 of file multi-link-element.cc.

References ns3::MicroSeconds(), and NS_ABORT_MSG_IF.

Referenced by EmlOperatingModeNotificationTest::DoRun(), ns3::MultiLinkElement::GetEmlsrPaddingDelay(), and ns3::MgtEmlOmn::Print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecodeEmlsrTransitionDelay()

Time ns3::CommonInfoBasicMle::DecodeEmlsrTransitionDelay ( uint8_t value )

static

Parameters

value the value for the EMLSR Transition Delay subfield

Returns: the corresponding EMLSR Transition delay

Definition at line 201 of file multi-link-element.cc.

References ns3::MicroSeconds(), and NS_ABORT_MSG_IF.

Referenced by EmlOperatingModeNotificationTest::DoRun(), ns3::EhtFrameExchangeManager::EmlsrSwitchToListening(), ns3::MultiLinkElement::GetEmlsrTransitionDelay(), and ns3::MgtEmlOmn::Print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Deserialize()

uint8_t ns3::CommonInfoBasicMle::Deserialize	(	Buffer::Iterator	start,
		uint16_t	presence )

Deserialize the Common Info field.

Parameters

start	iterator pointing to where the Common Info field should be read from
presence	the value of the Presence Bitmap field indicating which subfields are present in the Common Info field

Returns: the number of bytes read

Definition at line 86 of file multi-link-element.cc.

References m_bssParamsChangeCount, m_emlCapabilities, m_linkIdInfo, m_mediumSyncDelayInfo, m_mldCapabilities, m_mldMacAddress, NS_ABORT_MSG_IF, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadLsbtohU16(), and ns3::Buffer::Iterator::ReadU8().

Referenced by BasicMultiLinkElementTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EncodeEmlsrPaddingDelay()

uint8_t ns3::CommonInfoBasicMle::EncodeEmlsrPaddingDelay ( Time delay )

static

Parameters

delay the EMLSR Padding delay

Returns: the encoded value for the EMLSR Padding Delay subfield

Definition at line 146 of file multi-link-element.cc.

References ns3::Time::As(), ns3::Time::GetMicroSeconds(), NS_ABORT_MSG, and ns3::Time::US.

Referenced by EmlOperatingModeNotificationTest::DoRun(), and ns3::MultiLinkElement::SetEmlsrPaddingDelay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EncodeEmlsrTransitionDelay()

uint8_t ns3::CommonInfoBasicMle::EncodeEmlsrTransitionDelay ( Time delay )

static

Parameters

delay the EMLSR Transition delay

Returns: the encoded value for the EMLSR Transition Delay subfield

Definition at line 179 of file multi-link-element.cc.

References ns3::Time::As(), ns3::Time::GetMicroSeconds(), NS_ABORT_MSG, and ns3::Time::US.

Referenced by EmlOperatingModeNotificationTest::DoRun(), and ns3::MultiLinkElement::SetEmlsrTransitionDelay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMediumSyncDelayTimer()

Time ns3::CommonInfoBasicMle::GetMediumSyncDelayTimer ( ) const

Get the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in the Common Info field.

Make sure that the Medium Synchronization Delay Information subfield is present.

Returns: the timer duration

Definition at line 226 of file multi-link-element.cc.

References m_mediumSyncDelayInfo, ns3::MicroSeconds(), and NS_ASSERT.

Here is the call graph for this function:

◆ GetMediumSyncMaxNTxops()

std::optional< uint8_t > ns3::CommonInfoBasicMle::GetMediumSyncMaxNTxops ( ) const

Get the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running at a non-AP STA.

If no value is returned, no limit is imposed on the number of TXOPs. Make sure that the Medium Synchronization Delay Information subfield is present.

Returns: the number of TXOPs

Definition at line 273 of file multi-link-element.cc.

References m_mediumSyncDelayInfo, and NS_ASSERT.

◆ GetMediumSyncOfdmEdThreshold()

int8_t ns3::CommonInfoBasicMle::GetMediumSyncOfdmEdThreshold ( ) const

Get the Medium Synchronization OFDM ED Threshold in dBm.

Make sure that the Medium Synchronization Delay Information subfield is present.

Returns: the threshold in dBm

Definition at line 246 of file multi-link-element.cc.

References m_mediumSyncDelayInfo, and NS_ASSERT.

◆ GetPresenceBitmap()

uint16_t ns3::CommonInfoBasicMle::GetPresenceBitmap ( ) const

Get the Presence Bitmap subfield of the Common Info field.

CommonInfoBasicMle.

Returns: the Presence Bitmap subfield of the Common Info field

Definition at line 24 of file multi-link-element.cc.

References m_bssParamsChangeCount, m_emlCapabilities, m_linkIdInfo, m_mediumSyncDelayInfo, and m_mldCapabilities.

◆ GetSize()

uint8_t ns3::CommonInfoBasicMle::GetSize ( ) const

Get the size of the serialized Common Info field.

Returns: the size of the serialized Common Info field

Definition at line 35 of file multi-link-element.cc.

References m_bssParamsChangeCount, m_emlCapabilities, m_linkIdInfo, m_mediumSyncDelayInfo, and m_mldCapabilities.

Referenced by Serialize().

Here is the caller graph for this function:

◆ Serialize()

void ns3::CommonInfoBasicMle::Serialize ( Buffer::Iterator & start ) const

Serialize the Common Info field.

Parameters

start iterator pointing to where the Common Info field should be written to

Definition at line 47 of file multi-link-element.cc.

References GetSize(), m_bssParamsChangeCount, m_emlCapabilities, m_linkIdInfo, m_mediumSyncDelayInfo, m_mldCapabilities, m_mldMacAddress, and ns3::WriteTo().

Here is the call graph for this function:

◆ SetMediumSyncDelayTimer()

void ns3::CommonInfoBasicMle::SetMediumSyncDelayTimer ( Time delay )

Set the Medium Synchronization Duration subfield of the Medium Synchronization Delay Information in the Common Info field.

Parameters

delay the timer duration (must be a multiple of 32 microseconds)

Definition at line 212 of file multi-link-element.cc.

References ns3::Time::GetMicroSeconds(), m_mediumSyncDelayInfo, ns3::CommonInfoBasicMle::MediumSyncDelayInfo::mediumSyncDuration, and NS_ABORT_MSG_IF.

Referenced by BasicMultiLinkElementTest::GetMultiLinkElement(), and ns3::ApWifiMac::GetMultiLinkElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMediumSyncMaxNTxops()

void ns3::CommonInfoBasicMle::SetMediumSyncMaxNTxops ( uint8_t nTxops )

Set the Medium Synchronization Maximum Number of TXOPs subfield of the Medium Synchronization Delay Information in the Common Info field.

A value of zero indicates no limit on the maximum number of TXOPs.

Parameters

nTxops the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running at a non-AP STA

Definition at line 253 of file multi-link-element.cc.

References m_mediumSyncDelayInfo, ns3::CommonInfoBasicMle::MediumSyncDelayInfo::mediumSyncMaxNTxops, and NS_ASSERT_MSG.

Referenced by BasicMultiLinkElementTest::GetMultiLinkElement().

Here is the caller graph for this function:

◆ SetMediumSyncOfdmEdThreshold()

void ns3::CommonInfoBasicMle::SetMediumSyncOfdmEdThreshold ( int8_t threshold )

Set the Medium Synchronization OFDM ED Threshold subfield of the Medium Synchronization Delay Information in the Common Info field.

Parameters

threshold the threshold in dBm (ranges from -72 to -62 dBm)

Definition at line 233 of file multi-link-element.cc.

References m_mediumSyncDelayInfo, ns3::CommonInfoBasicMle::MediumSyncDelayInfo::mediumSyncOfdmEdThreshold, and NS_ABORT_MSG_IF.

Referenced by BasicMultiLinkElementTest::GetMultiLinkElement().

Here is the caller graph for this function:

Member Data Documentation

◆ m_bssParamsChangeCount

std::optional<uint8_t> ns3::CommonInfoBasicMle::m_bssParamsChangeCount

BSS Parameters Change Count.

Definition at line 77 of file multi-link-element.h.

Referenced by Deserialize(), BasicMultiLinkElementTest::DoRun(), BasicMultiLinkElementTest::GetMultiLinkElement(), GetPresenceBitmap(), GetSize(), and Serialize().

◆ m_emlCapabilities

std::optional<EmlCapabilities> ns3::CommonInfoBasicMle::m_emlCapabilities

EML Capabilities.

Definition at line 80 of file multi-link-element.h.

Referenced by Deserialize(), BasicMultiLinkElementTest::DoRun(), BasicMultiLinkElementTest::GetMultiLinkElement(), GetPresenceBitmap(), GetSize(), and Serialize().

◆ m_linkIdInfo

std::optional<uint8_t> ns3::CommonInfoBasicMle::m_linkIdInfo

Link ID Info.

Definition at line 76 of file multi-link-element.h.

Referenced by Deserialize(), BasicMultiLinkElementTest::DoRun(), BasicMultiLinkElementTest::GetMultiLinkElement(), GetPresenceBitmap(), GetSize(), and Serialize().

◆ m_mediumSyncDelayInfo

std::optional<MediumSyncDelayInfo> ns3::CommonInfoBasicMle::m_mediumSyncDelayInfo

Medium Synchronization Delay Information.

Definition at line 79 of file multi-link-element.h.

Referenced by Deserialize(), BasicMultiLinkElementTest::DoRun(), GetMediumSyncDelayTimer(), GetMediumSyncMaxNTxops(), GetMediumSyncOfdmEdThreshold(), BasicMultiLinkElementTest::GetMultiLinkElement(), GetPresenceBitmap(), GetSize(), Serialize(), SetMediumSyncDelayTimer(), SetMediumSyncMaxNTxops(), and SetMediumSyncOfdmEdThreshold().

◆ m_mldCapabilities

std::optional<MldCapabilities> ns3::CommonInfoBasicMle::m_mldCapabilities

MLD Capabilities.

Definition at line 81 of file multi-link-element.h.

Referenced by Deserialize(), ns3::ApWifiMac::GetMultiLinkElement(), ns3::StaWifiMac::GetMultiLinkElement(), GetPresenceBitmap(), GetSize(), and Serialize().

◆ m_mldMacAddress

Mac48Address ns3::CommonInfoBasicMle::m_mldMacAddress

Subfields.

MLD MAC Address

Definition at line 75 of file multi-link-element.h.

Referenced by Deserialize(), BasicMultiLinkElementTest::DoRun(), BasicMultiLinkElementTest::GetMultiLinkElement(), and Serialize().

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

src/wifi/model/eht/multi-link-element.h
src/wifi/model/eht/multi-link-element.cc

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ DecodeEmlsrPaddingDelay()

◆ DecodeEmlsrTransitionDelay()

◆ Deserialize()

◆ EncodeEmlsrPaddingDelay()

◆ EncodeEmlsrTransitionDelay()

◆ GetMediumSyncDelayTimer()

◆ GetMediumSyncMaxNTxops()

◆ GetMediumSyncOfdmEdThreshold()

◆ GetPresenceBitmap()

◆ GetSize()

◆ Serialize()

◆ SetMediumSyncDelayTimer()

◆ SetMediumSyncMaxNTxops()

◆ SetMediumSyncOfdmEdThreshold()

Member Data Documentation

◆ m_bssParamsChangeCount

◆ m_emlCapabilities

◆ m_linkIdInfo

◆ m_mediumSyncDelayInfo

◆ m_mldCapabilities

◆ m_mldMacAddress