Implement the header for management frames of type association request. More...
#include "mgt-headers.h"
Public Member Functions | |
MgtAssocRequestHeader () | |
~MgtAssocRequestHeader () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
const CapabilityInformation & | GetCapabilities () const |
Return the Capability information. More... | |
const std::optional< EhtCapabilities > & | GetEhtCapabilities () const |
Return the EHT capabilities, if present. More... | |
const std::optional< ExtendedCapabilities > & | GetExtendedCapabilities () const |
Return the extended capabilities, if present. More... | |
const std::optional< HeCapabilities > & | GetHeCapabilities () const |
Return the HE capabilities, if present. More... | |
const std::optional< HtCapabilities > & | GetHtCapabilities () const |
Return the HT capabilities, if present. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
uint16_t | GetListenInterval () const |
Return the listen interval. More... | |
const std::optional< MultiLinkElement > & | GetMultiLinkElement () const |
Return the Multi-Link Element information element, if present. More... | |
uint32_t | GetSerializedSize () const override |
const Ssid & | GetSsid () const |
Return the Service Set Identifier (SSID). More... | |
const SupportedRates & | GetSupportedRates () const |
Return the supported rates. More... | |
const std::optional< VhtCapabilities > & | GetVhtCapabilities () const |
Return the VHT capabilities, if present. More... | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetCapabilities (CapabilityInformation &&capabilities) |
Set the Capability information. More... | |
void | SetCapabilities (const CapabilityInformation &capabilities) |
Set the Capability information. More... | |
void | SetEhtCapabilities (const EhtCapabilities &ehtCapabilities) |
Set the EHT capabilities. More... | |
void | SetEhtCapabilities (EhtCapabilities &&ehtCapabilities) |
Set the EHT capabilities. More... | |
void | SetExtendedCapabilities (const ExtendedCapabilities &extendedCapabilities) |
Set the Extended Capabilities. More... | |
void | SetExtendedCapabilities (ExtendedCapabilities &&extendedCapabilities) |
Set the Extended Capabilities. More... | |
void | SetHeCapabilities (const HeCapabilities &heCapabilities) |
Set the HE capabilities. More... | |
void | SetHeCapabilities (HeCapabilities &&heCapabilities) |
Set the HE capabilities. More... | |
void | SetHtCapabilities (const HtCapabilities &htCapabilities) |
Set the HT capabilities. More... | |
void | SetHtCapabilities (HtCapabilities &&htCapabilities) |
Set the HT capabilities. More... | |
void | SetListenInterval (uint16_t interval) |
Set the listen interval. More... | |
void | SetMultiLinkElement (const MultiLinkElement &multiLinkElement) |
Set the Multi-Link Element information element. More... | |
void | SetMultiLinkElement (MultiLinkElement &&multiLinkElement) |
Set the Multi-Link Element information element. More... | |
void | SetSsid (const Ssid &ssid) |
Set the Service Set Identifier (SSID). More... | |
void | SetSsid (Ssid &&ssid) |
Set the Service Set Identifier (SSID). More... | |
void | SetSupportedRates (const SupportedRates &rates) |
Set the supported rates. More... | |
void | SetSupportedRates (SupportedRates &&rates) |
Set the supported rates. More... | |
void | SetVhtCapabilities (const VhtCapabilities &vhtCapabilities) |
Set the VHT capabilities. More... | |
void | SetVhtCapabilities (VhtCapabilities &&vhtCapabilities) |
Set the VHT capabilities. More... | |
![]() | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. More... | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
![]() | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. More... | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
CapabilityInformation | m_capability |
Capability information. More... | |
std::optional< EhtCapabilities > | m_ehtCapability |
EHT capabilities. More... | |
std::optional< ExtendedCapabilities > | m_extendedCapability |
Extended capabilities. More... | |
std::optional< HeCapabilities > | m_heCapability |
HE capabilities. More... | |
std::optional< HtCapabilities > | m_htCapability |
HT capabilities. More... | |
uint16_t | m_listenInterval |
listen interval More... | |
std::optional< MultiLinkElement > | m_multiLinkElement |
Multi-Link Element. More... | |
SupportedRates | m_rates |
List of supported rates. More... | |
Ssid | m_ssid |
Service Set ID (SSID) More... | |
std::optional< VhtCapabilities > | m_vhtCapability |
VHT capabilities. More... | |
Additional Inherited Members | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. More... | |
![]() | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Implement the header for management frames of type association request.
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 1040 bytes (on a 64-bit architecture).
Definition at line 54 of file mgt-headers.h.
ns3::MgtAssocRequestHeader::MgtAssocRequestHeader | ( | ) |
Definition at line 919 of file mgt-headers.cc.
|
override |
Definition at line 924 of file mgt-headers.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 1223 of file mgt-headers.cc.
References ns3::WifiInformationElement::Deserialize(), ns3::CapabilityInformation::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), ns3::SupportedRates::IsSupportedRate(), m_capability, m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_listenInterval, m_multiLinkElement, m_rates, m_ssid, m_vhtCapability, ns3::Buffer::Iterator::ReadLsbtohU16(), two-ray-to-three-gpp-ch-calibration::start, and ns3::WIFI_MAC_MGT_ASSOCIATION_REQUEST.
Referenced by ns3::MultiLinkElement::PerStaProfileSubelement::DeserializeInformationField().
const CapabilityInformation & ns3::MgtAssocRequestHeader::GetCapabilities | ( | ) | const |
Return the Capability information.
Definition at line 971 of file mgt-headers.cc.
References m_capability.
const std::optional< EhtCapabilities > & ns3::MgtAssocRequestHeader::GetEhtCapabilities | ( | ) | const |
Return the EHT capabilities, if present.
Definition at line 1061 of file mgt-headers.cc.
References m_ehtCapability.
const std::optional< ExtendedCapabilities > & ns3::MgtAssocRequestHeader::GetExtendedCapabilities | ( | ) | const |
Return the extended capabilities, if present.
Definition at line 989 of file mgt-headers.cc.
References m_extendedCapability.
const std::optional< HeCapabilities > & ns3::MgtAssocRequestHeader::GetHeCapabilities | ( | ) | const |
Return the HE capabilities, if present.
Definition at line 1043 of file mgt-headers.cc.
References m_heCapability.
const std::optional< HtCapabilities > & ns3::MgtAssocRequestHeader::GetHtCapabilities | ( | ) | const |
Return the HT capabilities, if present.
Definition at line 1007 of file mgt-headers.cc.
References m_htCapability.
|
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.
Implements ns3::ObjectBase.
Definition at line 1113 of file mgt-headers.cc.
References GetTypeId().
uint16_t ns3::MgtAssocRequestHeader::GetListenInterval | ( | ) | const |
Return the listen interval.
Definition at line 1097 of file mgt-headers.cc.
References m_listenInterval.
const std::optional< MultiLinkElement > & ns3::MgtAssocRequestHeader::GetMultiLinkElement | ( | ) | const |
Return the Multi-Link Element information element, if present.
Definition at line 1079 of file mgt-headers.cc.
References m_multiLinkElement.
Referenced by MultiLinkSetupTest::CheckAssocRequest().
|
overridevirtual |
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 1119 of file mgt-headers.cc.
References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), ns3::CapabilityInformation::GetSerializedSize(), ns3::WifiInformationElement::GetSerializedSize(), m_capability, m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_multiLinkElement, m_rates, m_ssid, and m_vhtCapability.
const Ssid & ns3::MgtAssocRequestHeader::GetSsid | ( | ) | const |
Return the Service Set Identifier (SSID).
Definition at line 1085 of file mgt-headers.cc.
References m_ssid.
const SupportedRates & ns3::MgtAssocRequestHeader::GetSupportedRates | ( | ) | const |
Return the supported rates.
Definition at line 1091 of file mgt-headers.cc.
References m_rates.
|
static |
Register this type.
Definition at line 1103 of file mgt-headers.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
const std::optional< VhtCapabilities > & ns3::MgtAssocRequestHeader::GetVhtCapabilities | ( | ) | const |
Return the VHT capabilities, if present.
Definition at line 1025 of file mgt-headers.cc.
References m_vhtCapability.
|
overridevirtual |
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 1158 of file mgt-headers.cc.
References m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.
|
overridevirtual |
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 1185 of file mgt-headers.cc.
References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), m_capability, m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_listenInterval, m_multiLinkElement, m_rates, m_ssid, m_vhtCapability, ns3::WifiInformationElement::Serialize(), ns3::CapabilityInformation::Serialize(), two-ray-to-three-gpp-ch-calibration::start, and ns3::Buffer::Iterator::WriteHtolsbU16().
void ns3::MgtAssocRequestHeader::SetCapabilities | ( | CapabilityInformation && | capabilities | ) |
Set the Capability information.
capabilities | Capability information |
Definition at line 965 of file mgt-headers.cc.
References m_capability.
void ns3::MgtAssocRequestHeader::SetCapabilities | ( | const CapabilityInformation & | capabilities | ) |
Set the Capability information.
capabilities | Capability information |
Definition at line 959 of file mgt-headers.cc.
References m_capability.
Referenced by BasicMultiLinkElementTest::DoRun().
void ns3::MgtAssocRequestHeader::SetEhtCapabilities | ( | const EhtCapabilities & | ehtCapabilities | ) |
Set the EHT capabilities.
ehtCapabilities | EHT capabilities |
Definition at line 1049 of file mgt-headers.cc.
References m_ehtCapability.
void ns3::MgtAssocRequestHeader::SetEhtCapabilities | ( | EhtCapabilities && | ehtCapabilities | ) |
Set the EHT capabilities.
ehtCapabilities | EHT capabilities |
Definition at line 1055 of file mgt-headers.cc.
References m_ehtCapability.
void ns3::MgtAssocRequestHeader::SetExtendedCapabilities | ( | const ExtendedCapabilities & | extendedCapabilities | ) |
Set the Extended Capabilities.
extendedCapabilities | the Extended Capabilities |
Definition at line 977 of file mgt-headers.cc.
References m_extendedCapability.
void ns3::MgtAssocRequestHeader::SetExtendedCapabilities | ( | ExtendedCapabilities && | extendedCapabilities | ) |
Set the Extended Capabilities.
extendedCapabilities | the Extended Capabilities |
Definition at line 983 of file mgt-headers.cc.
References m_extendedCapability.
void ns3::MgtAssocRequestHeader::SetHeCapabilities | ( | const HeCapabilities & | heCapabilities | ) |
Set the HE capabilities.
heCapabilities | HE capabilities |
Definition at line 1031 of file mgt-headers.cc.
References m_heCapability.
void ns3::MgtAssocRequestHeader::SetHeCapabilities | ( | HeCapabilities && | heCapabilities | ) |
Set the HE capabilities.
heCapabilities | HE capabilities |
Definition at line 1037 of file mgt-headers.cc.
References m_heCapability.
void ns3::MgtAssocRequestHeader::SetHtCapabilities | ( | const HtCapabilities & | htCapabilities | ) |
Set the HT capabilities.
htCapabilities | HT capabilities |
Definition at line 995 of file mgt-headers.cc.
References m_htCapability.
void ns3::MgtAssocRequestHeader::SetHtCapabilities | ( | HtCapabilities && | htCapabilities | ) |
Set the HT capabilities.
htCapabilities | HT capabilities |
Definition at line 1001 of file mgt-headers.cc.
References m_htCapability.
void ns3::MgtAssocRequestHeader::SetListenInterval | ( | uint16_t | interval | ) |
Set the listen interval.
interval | the listen interval |
Definition at line 953 of file mgt-headers.cc.
References m_listenInterval.
Referenced by BasicMultiLinkElementTest::DoRun().
void ns3::MgtAssocRequestHeader::SetMultiLinkElement | ( | const MultiLinkElement & | multiLinkElement | ) |
Set the Multi-Link Element information element.
multiLinkElement | the Multi-Link Element information element |
Definition at line 1067 of file mgt-headers.cc.
References m_multiLinkElement.
void ns3::MgtAssocRequestHeader::SetMultiLinkElement | ( | MultiLinkElement && | multiLinkElement | ) |
Set the Multi-Link Element information element.
multiLinkElement | the Multi-Link Element information element |
Definition at line 1073 of file mgt-headers.cc.
References m_multiLinkElement.
void ns3::MgtAssocRequestHeader::SetSsid | ( | const Ssid & | ssid | ) |
Set the Service Set Identifier (SSID).
ssid | SSID |
Definition at line 929 of file mgt-headers.cc.
References m_ssid, and third::ssid.
Referenced by BasicMultiLinkElementTest::DoRun().
void ns3::MgtAssocRequestHeader::SetSsid | ( | Ssid && | ssid | ) |
Set the Service Set Identifier (SSID).
ssid | SSID |
Definition at line 935 of file mgt-headers.cc.
References m_ssid, and third::ssid.
void ns3::MgtAssocRequestHeader::SetSupportedRates | ( | const SupportedRates & | rates | ) |
Set the supported rates.
rates | the supported rates |
Definition at line 941 of file mgt-headers.cc.
References m_rates.
Referenced by BasicMultiLinkElementTest::DoRun().
void ns3::MgtAssocRequestHeader::SetSupportedRates | ( | SupportedRates && | rates | ) |
Set the supported rates.
rates | the supported rates |
Definition at line 947 of file mgt-headers.cc.
References m_rates.
void ns3::MgtAssocRequestHeader::SetVhtCapabilities | ( | const VhtCapabilities & | vhtCapabilities | ) |
Set the VHT capabilities.
vhtCapabilities | VHT capabilities |
Definition at line 1013 of file mgt-headers.cc.
References m_vhtCapability.
void ns3::MgtAssocRequestHeader::SetVhtCapabilities | ( | VhtCapabilities && | vhtCapabilities | ) |
Set the VHT capabilities.
vhtCapabilities | VHT capabilities |
Definition at line 1019 of file mgt-headers.cc.
References m_vhtCapability.
|
private |
Capability information.
Definition at line 233 of file mgt-headers.h.
Referenced by Deserialize(), GetCapabilities(), GetSerializedSize(), Serialize(), and SetCapabilities().
|
private |
EHT capabilities.
Definition at line 239 of file mgt-headers.h.
Referenced by Deserialize(), GetEhtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetEhtCapabilities().
|
private |
Extended capabilities.
Definition at line 234 of file mgt-headers.h.
Referenced by Deserialize(), GetExtendedCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetExtendedCapabilities().
|
private |
HE capabilities.
Definition at line 237 of file mgt-headers.h.
Referenced by Deserialize(), GetHeCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHeCapabilities().
|
private |
HT capabilities.
Definition at line 235 of file mgt-headers.h.
Referenced by Deserialize(), GetHtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHtCapabilities().
|
private |
listen interval
Definition at line 238 of file mgt-headers.h.
Referenced by Deserialize(), GetListenInterval(), Serialize(), and SetListenInterval().
|
private |
Multi-Link Element.
Definition at line 240 of file mgt-headers.h.
Referenced by Deserialize(), GetMultiLinkElement(), GetSerializedSize(), Serialize(), and SetMultiLinkElement().
|
private |
List of supported rates.
Definition at line 232 of file mgt-headers.h.
Referenced by Deserialize(), GetSerializedSize(), GetSupportedRates(), Print(), Serialize(), and SetSupportedRates().
|
private |
Service Set ID (SSID)
Definition at line 231 of file mgt-headers.h.
Referenced by Deserialize(), GetSerializedSize(), GetSsid(), Print(), Serialize(), and SetSsid().
|
private |
VHT capabilities.
Definition at line 236 of file mgt-headers.h.
Referenced by Deserialize(), GetSerializedSize(), GetVhtCapabilities(), Print(), Serialize(), and SetVhtCapabilities().