Implement the header for Action frames of type EML Operating Mode Notification. More...

#include "mgt-action-headers.h"

Inheritance diagram for ns3::MgtEmlOmn:

Collaboration diagram for ns3::MgtEmlOmn:

Classes
struct	EmlControl
	EML Control field. More...

struct	EmlsrParamUpdate
	EMLSR Parameter Update field. More...

Public Member Functions
	MgtEmlOmn ()=default

uint32_t	Deserialize (Buffer::Iterator start) override

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

std::list< uint8_t >	GetLinkBitmap () const

uint32_t	GetSerializedSize () const override

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetLinkIdInBitmap (uint8_t linkId)
	Set the bit position in the link bitmap corresponding to the given link.

Public Member Functions inherited from ns3::Header
	~Header () override

uint32_t	Deserialize (Buffer::Iterator start) override=0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual uint32_t	GetSerializedSize () const =0

void	Print (std::ostream &os) const override=0

virtual void	Serialize (Buffer::Iterator start) const =0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual void	Print (std::ostream &os) const =0
	Print the object contents.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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 ()
	Register this type.

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Public Attributes
uint8_t	m_dialogToken {0}
	Dialog Token.

EmlControl	m_emlControl {}
	EML Control field.

std::optional< EmlsrParamUpdate >	m_emlsrParamUpdate {}
	EMLSR Parameter Update field.

Additional Inherited Members
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.

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

Detailed Description

Implement the header for Action frames of type EML Operating Mode Notification.

Definition at line 614 of file mgt-action-headers.h.

Constructor & Destructor Documentation

◆ MgtEmlOmn()

ns3::MgtEmlOmn::MgtEmlOmn ( )

default

Member Function Documentation

◆ Deserialize()

uint32_t ns3::MgtEmlOmn::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 1292 of file mgt-action-headers.cc.

References ns3::MgtEmlOmn::EmlControl::emlmrMode, ns3::MgtEmlOmn::EmlControl::emlsrMode, ns3::MgtEmlOmn::EmlControl::emlsrParamUpdateCtrl, ns3::Buffer::Iterator::GetDistanceFrom(), ns3::MgtEmlOmn::EmlControl::linkBitmap, m_dialogToken, m_emlControl, m_emlsrParamUpdate, NS_ABORT_MSG_IF, ns3::Buffer::Iterator::ReadLsbtohU16(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::MgtEmlOmn::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 1211 of file mgt-action-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetLinkBitmap()

std::list< uint8_t > ns3::MgtEmlOmn::GetLinkBitmap ( ) const

Returns: the ID of the links whose bit position in the link bitmap is set to 1

Definition at line 1336 of file mgt-action-headers.cc.

References ns3::MgtEmlOmn::EmlControl::linkBitmap, list, m_emlControl, and NS_ASSERT_MSG.

Referenced by EmlOmnExchangeTest::CheckEmlNotification(), EmlOperatingModeNotificationTest::DoRun(), and ns3::ApWifiMac::ReceiveEmlOmn().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MgtEmlOmn::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 1237 of file mgt-action-headers.cc.

References ns3::MgtEmlOmn::EmlControl::linkBitmap, m_emlControl, m_emlsrParamUpdate, and ns3::MgtEmlOmn::EmlControl::mcsMapCountCtrl.

◆ GetTypeId()

TypeId ns3::MgtEmlOmn::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 1201 of file mgt-action-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::MgtEmlOmn::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 1217 of file mgt-action-headers.cc.

References ns3::Time::As(), ns3::CommonInfoBasicMle::DecodeEmlsrPaddingDelay(), ns3::CommonInfoBasicMle::DecodeEmlsrTransitionDelay(), ns3::MgtEmlOmn::EmlControl::emlmrMode, ns3::MgtEmlOmn::EmlControl::emlsrMode, ns3::MgtEmlOmn::EmlControl::emlsrParamUpdateCtrl, ns3::MgtEmlOmn::EmlControl::linkBitmap, m_emlControl, m_emlsrParamUpdate, and ns3::Time::US.

Here is the call graph for this function:

◆ Serialize()

void ns3::MgtEmlOmn::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 1257 of file mgt-action-headers.cc.

References ns3::MgtEmlOmn::EmlControl::emlmrMode, ns3::MgtEmlOmn::EmlControl::emlsrMode, ns3::MgtEmlOmn::EmlControl::emlsrParamUpdateCtrl, ns3::MgtEmlOmn::EmlControl::linkBitmap, m_dialogToken, m_emlControl, m_emlsrParamUpdate, and NS_ABORT_MSG_IF.

◆ SetLinkIdInBitmap()

void ns3::MgtEmlOmn::SetLinkIdInBitmap ( uint8_t linkId )

Set the bit position in the link bitmap corresponding to the given link.

Parameters

linkId the ID of the given link

Definition at line 1325 of file mgt-action-headers.cc.

References ns3::MgtEmlOmn::EmlControl::linkBitmap, m_emlControl, and NS_ABORT_MSG_IF.

Referenced by EmlOperatingModeNotificationTest::DoRun(), and ns3::EmlsrManager::GetEmlOmn().

Here is the caller graph for this function:

Member Data Documentation

◆ m_dialogToken

uint8_t ns3::MgtEmlOmn::m_dialogToken {0}

Dialog Token.

Definition at line 664 of file mgt-action-headers.h.

Referenced by Deserialize(), and Serialize().

◆ m_emlControl

EmlControl ns3::MgtEmlOmn::m_emlControl {}

EML Control field.

Definition at line 665 of file mgt-action-headers.h.

Referenced by EmlOmnExchangeTest::CheckEmlNotification(), Deserialize(), EmlOperatingModeNotificationTest::DoRun(), ns3::EmlsrManager::GetEmlOmn(), GetLinkBitmap(), GetSerializedSize(), Print(), ns3::ApWifiMac::ReceiveEmlOmn(), Serialize(), and SetLinkIdInBitmap().

◆ m_emlsrParamUpdate

std::optional<EmlsrParamUpdate> ns3::MgtEmlOmn::m_emlsrParamUpdate {}

EMLSR Parameter Update field.

Definition at line 666 of file mgt-action-headers.h.

Referenced by Deserialize(), EmlOperatingModeNotificationTest::DoRun(), ns3::EmlsrManager::GetEmlOmn(), GetSerializedSize(), Print(), ns3::ApWifiMac::ReceiveEmlOmn(), and Serialize().

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

src/wifi/model/mgt-action-headers.h
src/wifi/model/mgt-action-headers.cc

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MgtEmlOmn()

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetLinkBitmap()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetLinkIdInBitmap()

Member Data Documentation

◆ m_dialogToken

◆ m_emlControl

◆ m_emlsrParamUpdate