A Discrete-Event Network Simulator
API
ns3::MgtProbeRequestHeader Class Reference

Implement the header for management frames of type probe request. More...

#include "mgt-headers.h"

+ Inheritance diagram for ns3::MgtProbeRequestHeader:
+ Collaboration diagram for ns3::MgtProbeRequestHeader:

Public Member Functions

 ~MgtProbeRequestHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
const std::optional< EhtCapabilities > & GetEhtCapabilities (void) const
 Return the EHT capabilities, if present. More...
 
const std::optional< ExtendedCapabilities > & GetExtendedCapabilities (void) const
 Return the extended capabilities, if present. More...
 
const std::optional< HeCapabilities > & GetHeCapabilities (void) const
 Return the HE capabilities, if present. More...
 
const std::optional< HtCapabilities > & GetHtCapabilities (void) const
 Return the HT capabilities, if present. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize (void) const
 
const SsidGetSsid (void) const
 Return the Service Set Identifier (SSID). More...
 
const SupportedRatesGetSupportedRates (void) const
 Return the supported rates. More...
 
const std::optional< VhtCapabilities > & GetVhtCapabilities (void) const
 Return the VHT capabilities, if present. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
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 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...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t GetSerializedSize (void) const =0
 
virtual void Print (std::ostream &os) const =0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
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 void Print (std::ostream &os) const =0
 Print the object contents. More...
 
- Public Member Functions inherited from ns3::ObjectBase
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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::optional< EhtCapabilitiesm_ehtCapability
 EHT capabilities. More...
 
std::optional< ExtendedCapabilitiesm_extendedCapability
 extended capabilities More...
 
std::optional< HeCapabilitiesm_heCapability
 HE capabilities. More...
 
std::optional< HtCapabilitiesm_htCapability
 HT capabilities. More...
 
SupportedRates m_rates
 List of supported rates. More...
 
Ssid m_ssid
 Service Set ID (SSID) More...
 
std::optional< VhtCapabilitiesm_vhtCapability
 VHT capabilities. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Implement the header for management frames of type probe 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 688 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ ~MgtProbeRequestHeader()

ns3::MgtProbeRequestHeader::~MgtProbeRequestHeader ( )

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::MgtProbeRequestHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 224 of file mgt-headers.cc.

References ns3::WifiInformationElement::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, m_vhtCapability, and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetEhtCapabilities()

const std::optional< EhtCapabilities > & ns3::MgtProbeRequestHeader::GetEhtCapabilities ( void  ) const

Return the EHT capabilities, if present.

Returns
EHT capabilities, if present

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

References m_ehtCapability.

◆ GetExtendedCapabilities()

const std::optional< ExtendedCapabilities > & ns3::MgtProbeRequestHeader::GetExtendedCapabilities ( void  ) const

Return the extended capabilities, if present.

Returns
the extended capabilities, if present

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

References m_extendedCapability.

◆ GetHeCapabilities()

const std::optional< HeCapabilities > & ns3::MgtProbeRequestHeader::GetHeCapabilities ( void  ) const

Return the HE capabilities, if present.

Returns
HE capabilities, if present

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

References m_heCapability.

◆ GetHtCapabilities()

const std::optional< HtCapabilities > & ns3::MgtProbeRequestHeader::GetHtCapabilities ( void  ) const

Return the HT capabilities, if present.

Returns
HT capabilities, if present

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

References m_htCapability.

◆ GetInstanceTypeId()

TypeId ns3::MgtProbeRequestHeader::GetInstanceTypeId ( void  ) const
virtual

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 192 of file mgt-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MgtProbeRequestHeader::GetSerializedSize ( void  ) const
virtual
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 166 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), ns3::WifiInformationElement::GetSerializedSize(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

+ Here is the call graph for this function:

◆ GetSsid()

const Ssid & ns3::MgtProbeRequestHeader::GetSsid ( void  ) const

Return the Service Set Identifier (SSID).

Returns
SSID

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

References m_ssid.

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

+ Here is the caller graph for this function:

◆ GetSupportedRates()

const SupportedRates & ns3::MgtProbeRequestHeader::GetSupportedRates ( void  ) const

Return the supported rates.

Returns
the supported rates

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

References m_rates.

◆ GetTypeId()

TypeId ns3::MgtProbeRequestHeader::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 181 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:

◆ GetVhtCapabilities()

const std::optional< VhtCapabilities > & ns3::MgtProbeRequestHeader::GetVhtCapabilities ( void  ) const

Return the VHT capabilities, if present.

Returns
VHT capabilities, if present

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

References m_vhtCapability.

◆ Print()

void ns3::MgtProbeRequestHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 198 of file mgt-headers.cc.

References m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

◆ Serialize()

void ns3::MgtProbeRequestHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 210 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, m_vhtCapability, ns3::WifiInformationElement::Serialize(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetEhtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetEhtCapabilities ( const EhtCapabilities ehtCapabilities)

Set the EHT capabilities.

Parameters
ehtCapabilitiesEHT capabilities

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

References m_ehtCapability.

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

+ Here is the caller graph for this function:

◆ SetEhtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetEhtCapabilities ( EhtCapabilities &&  ehtCapabilities)

Set the EHT capabilities.

Parameters
ehtCapabilitiesEHT capabilities

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

References m_ehtCapability.

◆ SetExtendedCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetExtendedCapabilities ( const ExtendedCapabilities extendedCapabilities)

Set the extended capabilities.

Parameters
extendedCapabilitiesthe extended capabilities

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

References m_extendedCapability.

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

+ Here is the caller graph for this function:

◆ SetExtendedCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetExtendedCapabilities ( ExtendedCapabilities &&  extendedCapabilities)

Set the extended capabilities.

Parameters
extendedCapabilitiesthe extended capabilities

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

References m_extendedCapability.

◆ SetHeCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetHeCapabilities ( const HeCapabilities heCapabilities)

Set the HE capabilities.

Parameters
heCapabilitiesHE capabilities

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

References m_heCapability.

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

+ Here is the caller graph for this function:

◆ SetHeCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetHeCapabilities ( HeCapabilities &&  heCapabilities)

Set the HE capabilities.

Parameters
heCapabilitiesHE capabilities

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

References m_heCapability.

◆ SetHtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetHtCapabilities ( const HtCapabilities htCapabilities)

Set the HT capabilities.

Parameters
htCapabilitiesHT capabilities

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

References m_htCapability.

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

+ Here is the caller graph for this function:

◆ SetHtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetHtCapabilities ( HtCapabilities &&  htCapabilities)

Set the HT capabilities.

Parameters
htCapabilitiesHT capabilities

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

References m_htCapability.

◆ SetSsid() [1/2]

void ns3::MgtProbeRequestHeader::SetSsid ( const Ssid ssid)

Set the Service Set Identifier (SSID).

Parameters
ssidSSID

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

References m_ssid, and third::ssid.

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

+ Here is the caller graph for this function:

◆ SetSsid() [2/2]

void ns3::MgtProbeRequestHeader::SetSsid ( Ssid &&  ssid)

Set the Service Set Identifier (SSID).

Parameters
ssidSSID

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

References m_ssid, and third::ssid.

◆ SetSupportedRates() [1/2]

void ns3::MgtProbeRequestHeader::SetSupportedRates ( const SupportedRates rates)

Set the supported rates.

Parameters
ratesthe supported rates

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

References m_rates.

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

+ Here is the caller graph for this function:

◆ SetSupportedRates() [2/2]

void ns3::MgtProbeRequestHeader::SetSupportedRates ( SupportedRates &&  rates)

Set the supported rates.

Parameters
ratesthe supported rates

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

References m_rates.

◆ SetVhtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetVhtCapabilities ( const VhtCapabilities vhtCapabilities)

Set the VHT capabilities.

Parameters
vhtCapabilitiesVHT capabilities

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

References m_vhtCapability.

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

+ Here is the caller graph for this function:

◆ SetVhtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetVhtCapabilities ( VhtCapabilities &&  vhtCapabilities)

Set the VHT capabilities.

Parameters
vhtCapabilitiesVHT capabilities

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

References m_vhtCapability.

Member Data Documentation

◆ m_ehtCapability

std::optional<EhtCapabilities> ns3::MgtProbeRequestHeader::m_ehtCapability
private

EHT capabilities.

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

Referenced by Deserialize(), GetEhtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetEhtCapabilities().

◆ m_extendedCapability

std::optional<ExtendedCapabilities> ns3::MgtProbeRequestHeader::m_extendedCapability
private

extended capabilities

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

Referenced by Deserialize(), GetExtendedCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetExtendedCapabilities().

◆ m_heCapability

std::optional<HeCapabilities> ns3::MgtProbeRequestHeader::m_heCapability
private

HE capabilities.

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

Referenced by Deserialize(), GetHeCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHeCapabilities().

◆ m_htCapability

std::optional<HtCapabilities> ns3::MgtProbeRequestHeader::m_htCapability
private

HT capabilities.

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

Referenced by Deserialize(), GetHtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHtCapabilities().

◆ m_rates

SupportedRates ns3::MgtProbeRequestHeader::m_rates
private

List of supported rates.

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

Referenced by Deserialize(), GetSerializedSize(), GetSupportedRates(), Print(), Serialize(), and SetSupportedRates().

◆ m_ssid

Ssid ns3::MgtProbeRequestHeader::m_ssid
private

Service Set ID (SSID)

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

Referenced by Deserialize(), GetSerializedSize(), GetSsid(), Print(), Serialize(), and SetSsid().

◆ m_vhtCapability

std::optional<VhtCapabilities> ns3::MgtProbeRequestHeader::m_vhtCapability
private

VHT capabilities.

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

Referenced by Deserialize(), GetSerializedSize(), GetVhtCapabilities(), Print(), Serialize(), and SetVhtCapabilities().


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