Implement the header for management frames of type association and reassociation response. More...

#include "mgt-headers.h"

Inheritance diagram for ns3::MgtAssocResponseHeader:

Collaboration diagram for ns3::MgtAssocResponseHeader:

Public Member Functions
	~MgtAssocResponseHeader () override=default

CapabilityInformation &	Capabilities ()

const CapabilityInformation &	Capabilities () const

uint16_t	GetAssociationId () const
	Return the association ID.

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

StatusCode	GetStatusCode ()
	Return the status code.

void	SetAssociationId (uint16_t aid)
	Set the association ID.

void	SetStatusCode (StatusCode code)
	Set the status code.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Protected Member Functions
uint32_t	DeserializeFromPerStaProfileImpl (Buffer::Iterator start, uint16_t length, const MgtAssocResponseHeader &frame)
	Deserialize this header from a Per-STA Profile subelement of a Multi-Link Element.

uint32_t	DeserializeImpl (Buffer::Iterator start)

uint32_t	GetSerializedSizeImpl () const

uint32_t	GetSerializedSizeInPerStaProfileImpl (const MgtAssocResponseHeader &frame) const

void	PrintImpl (std::ostream &os) const

void	SerializeImpl (Buffer::Iterator start) const

void	SerializeInPerStaProfileImpl (Buffer::Iterator start, const MgtAssocResponseHeader &frame) const
	Serialize this header into a Per-STA Profile subelement of a Multi-Link Element.

Private Attributes
uint16_t	m_aid {0}
	AID.

CapabilityInformation	m_capability
	Capability information.

StatusCode	m_code
	Status code.

Friends
class	MgtHeaderInPerStaProfile< MgtAssocResponseHeader, AssocResponseElems >

class	WifiMgtHeader< MgtAssocResponseHeader, AssocResponseElems >

Detailed Description

Implement the header for management frames of type association and reassociation response.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 1536 bytes (on a 64-bit architecture).

Definition at line 332 of file mgt-headers.h.

Constructor & Destructor Documentation

◆ ~MgtAssocResponseHeader()

ns3::MgtAssocResponseHeader::~MgtAssocResponseHeader ( )

overridedefault

Member Function Documentation

◆ Capabilities() [1/2]

CapabilityInformation & ns3::MgtAssocResponseHeader::Capabilities ( )

Returns: a reference to the Capability information

Definition at line 474 of file mgt-headers.cc.

References m_capability.

Referenced by ns3::ApWifiMac::GetAssocResp().

Here is the caller graph for this function:

◆ Capabilities() [2/2]

const CapabilityInformation & ns3::MgtAssocResponseHeader::Capabilities ( ) const

Returns: a const reference to the Capability information

Definition at line 468 of file mgt-headers.cc.

References m_capability.

◆ DeserializeFromPerStaProfileImpl()

uint32_t ns3::MgtAssocResponseHeader::DeserializeFromPerStaProfileImpl	(	Buffer::Iterator	start,
		uint16_t	length,
		const MgtAssocResponseHeader &	frame
	)

protected

Deserialize this header from a Per-STA Profile subelement of a Multi-Link Element.

Parameters

start	an iterator which points to where the header should be read from
length	the expected number of bytes to read
frame	the frame containing the Multi-Link Element

Returns: the number of bytes read

Definition at line 573 of file mgt-headers.cc.

References ns3::CapabilityInformation::Deserialize(), ns3::StatusCode::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_aid, m_capability, m_code, and NS_ASSERT_MSG.

Here is the call graph for this function:

◆ DeserializeImpl()

uint32_t ns3::MgtAssocResponseHeader::DeserializeImpl ( Buffer::Iterator start )

protected

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.

Definition at line 549 of file mgt-headers.cc.

References ns3::CapabilityInformation::Deserialize(), ns3::StatusCode::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_aid, m_capability, m_code, and ns3::Buffer::Iterator::ReadLsbtohU16().

Here is the call graph for this function:

◆ GetAssociationId()

uint16_t ns3::MgtAssocResponseHeader::GetAssociationId ( ) const

Return the association ID.

Returns: the association ID

Definition at line 486 of file mgt-headers.cc.

References m_aid.

Referenced by ns3::StaWifiMac::ReceiveAssocResp().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::MgtAssocResponseHeader::GetInstanceTypeId ( ) const

override

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.

Definition at line 450 of file mgt-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSizeImpl()

uint32_t ns3::MgtAssocResponseHeader::GetSerializedSizeImpl ( ) const

protected

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.

Definition at line 492 of file mgt-headers.cc.

References ns3::CapabilityInformation::GetSerializedSize(), ns3::StatusCode::GetSerializedSize(), m_capability, and m_code.

Here is the call graph for this function:

◆ GetSerializedSizeInPerStaProfileImpl()

uint32_t ns3::MgtAssocResponseHeader::GetSerializedSizeInPerStaProfileImpl ( const MgtAssocResponseHeader & frame ) const

protected

Parameters

frame the frame containing the Multi-Link Element

Returns: the number of bytes that are needed to serialize this header into a Per-STA Profile subelement of the Multi-Link Element

Definition at line 505 of file mgt-headers.cc.

References ns3::CapabilityInformation::GetSerializedSize(), ns3::StatusCode::GetSerializedSize(), GetSerializedSizeInPerStaProfileImpl(), m_capability, and m_code.

Referenced by GetSerializedSizeInPerStaProfileImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStatusCode()

StatusCode ns3::MgtAssocResponseHeader::GetStatusCode ( )

Return the status code.

Returns: the status code

Definition at line 456 of file mgt-headers.cc.

References m_code.

Referenced by ns3::ApWifiMac::GetLinkIdStaAddrMap(), ns3::StaWifiMac::ReceiveAssocResp(), and ns3::ApWifiMac::SetAid().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MgtAssocResponseHeader::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 440 of file mgt-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:

◆ PrintImpl()

void ns3::MgtAssocResponseHeader::PrintImpl ( std::ostream & os ) const

protected

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

Definition at line 518 of file mgt-headers.cc.

References m_aid, and m_code.

◆ SerializeImpl()

void ns3::MgtAssocResponseHeader::SerializeImpl ( Buffer::Iterator start ) const

protected

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.

Definition at line 526 of file mgt-headers.cc.

References m_aid, m_capability, m_code, ns3::CapabilityInformation::Serialize(), ns3::StatusCode::Serialize(), and ns3::Buffer::Iterator::WriteHtolsbU16().

Here is the call graph for this function:

◆ SerializeInPerStaProfileImpl()

void ns3::MgtAssocResponseHeader::SerializeInPerStaProfileImpl	(	Buffer::Iterator	start,
		const MgtAssocResponseHeader &	frame
	)		const

protected

Serialize this header into a Per-STA Profile subelement of a Multi-Link Element.

Parameters

start	an iterator which points to where the header should be written
frame	the frame containing the Multi-Link Element

Definition at line 538 of file mgt-headers.cc.

References m_capability, m_code, ns3::CapabilityInformation::Serialize(), ns3::StatusCode::Serialize(), and SerializeInPerStaProfileImpl().

Referenced by SerializeInPerStaProfileImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAssociationId()

void ns3::MgtAssocResponseHeader::SetAssociationId ( uint16_t aid )

Set the association ID.

Parameters

aid	the association ID

Definition at line 480 of file mgt-headers.cc.

References m_aid.

Referenced by ns3::ApWifiMac::SetAid().

Here is the caller graph for this function:

◆ SetStatusCode()

void ns3::MgtAssocResponseHeader::SetStatusCode ( StatusCode code )

Set the status code.

Parameters

code	the status code

Definition at line 462 of file mgt-headers.cc.

References m_code.

Referenced by ns3::ApWifiMac::GetAssocResp().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ MgtHeaderInPerStaProfile< MgtAssocResponseHeader, AssocResponseElems >

friend class MgtHeaderInPerStaProfile< MgtAssocResponseHeader, AssocResponseElems >

friend

Definition at line 325 of file mgt-headers.h.

◆ WifiMgtHeader< MgtAssocResponseHeader, AssocResponseElems >

friend class WifiMgtHeader< MgtAssocResponseHeader, AssocResponseElems >

friend

Definition at line 325 of file mgt-headers.h.

Member Data Documentation

◆ m_aid

uint16_t ns3::MgtAssocResponseHeader::m_aid {0}

private

AID.

Definition at line 424 of file mgt-headers.h.

Referenced by DeserializeFromPerStaProfileImpl(), DeserializeImpl(), GetAssociationId(), PrintImpl(), SerializeImpl(), and SetAssociationId().

◆ m_capability

CapabilityInformation ns3::MgtAssocResponseHeader::m_capability

private

Capability information.

Definition at line 422 of file mgt-headers.h.

Referenced by Capabilities(), DeserializeFromPerStaProfileImpl(), DeserializeImpl(), GetSerializedSizeImpl(), GetSerializedSizeInPerStaProfileImpl(), SerializeImpl(), and SerializeInPerStaProfileImpl().

◆ m_code

StatusCode ns3::MgtAssocResponseHeader::m_code

private

Status code.

Definition at line 423 of file mgt-headers.h.

Referenced by DeserializeFromPerStaProfileImpl(), DeserializeImpl(), GetSerializedSizeImpl(), GetSerializedSizeInPerStaProfileImpl(), GetStatusCode(), PrintImpl(), SerializeImpl(), SerializeInPerStaProfileImpl(), and SetStatusCode().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~MgtAssocResponseHeader()

Member Function Documentation

◆ Capabilities() [1/2]

◆ Capabilities() [2/2]

◆ DeserializeFromPerStaProfileImpl()

◆ DeserializeImpl()

◆ GetAssociationId()

◆ GetInstanceTypeId()

◆ GetSerializedSizeImpl()

◆ GetSerializedSizeInPerStaProfileImpl()

◆ GetStatusCode()

◆ GetTypeId()

◆ PrintImpl()

◆ SerializeImpl()

◆ SerializeInPerStaProfileImpl()

◆ SetAssociationId()

◆ SetStatusCode()

Friends And Related Function Documentation

◆ MgtHeaderInPerStaProfile< MgtAssocResponseHeader, AssocResponseElems >

◆ WifiMgtHeader< MgtAssocResponseHeader, AssocResponseElems >

Member Data Documentation

◆ m_aid

◆ m_capability

◆ m_code