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

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

#include "mgt-headers.h"

+ Inheritance diagram for ns3::MgtProbeResponseHeader:
+ Collaboration diagram for ns3::MgtProbeResponseHeader:

Public Member Functions

 MgtProbeResponseHeader ()
 
 ~MgtProbeResponseHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
uint64_t GetBeaconIntervalUs (void) const
 Return the beacon interval in microseconds unit. More...
 
CapabilityInformation GetCapabilities (void) const
 Return the Capability information. More...
 
CfParameterSet GetCfParameterSet (void) const
 Return the CF parameter set. More...
 
DsssParameterSet GetDsssParameterSet (void) const
 Return the DSSS Parameter Set. More...
 
EdcaParameterSet GetEdcaParameterSet (void) const
 Return the EDCA Parameter Set. More...
 
ErpInformation GetErpInformation (void) const
 Return the ERP information. More...
 
ExtendedCapabilities GetExtendedCapabilities (void) const
 Return the extended capabilities. More...
 
HeCapabilities GetHeCapabilities (void) const
 Return the HE capabilities. More...
 
HeOperation GetHeOperation (void) const
 Return the HE operation. More...
 
HtCapabilities GetHtCapabilities (void) const
 Return the HT capabilities. More...
 
HtOperation GetHtOperation (void) const
 Return the HT operation. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize (void) const
 
Ssid GetSsid (void) const
 Return the Service Set Identifier (SSID). More...
 
SupportedRates GetSupportedRates (void) const
 Return the supported rates. More...
 
uint64_t GetTimestamp ()
 Return the time stamp. More...
 
VhtCapabilities GetVhtCapabilities (void) const
 Return the VHT capabilities. More...
 
VhtOperation GetVhtOperation (void) const
 Return the VHT operation. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetBeaconIntervalUs (uint64_t us)
 Set the beacon interval in microseconds unit. More...
 
void SetCapabilities (CapabilityInformation capabilities)
 Set the Capability information. More...
 
void SetCfParameterSet (CfParameterSet cfparameterset)
 Set the CF parameter set. More...
 
void SetDsssParameterSet (DsssParameterSet dsssParameterSet)
 Set the DSSS Parameter Set. More...
 
void SetEdcaParameterSet (EdcaParameterSet edcaParameterSet)
 Set the EDCA Parameter Set. More...
 
void SetErpInformation (ErpInformation erpInformation)
 Set the ERP information. More...
 
void SetExtendedCapabilities (ExtendedCapabilities extendedcapabilities)
 Set the extended capabilities. More...
 
void SetHeCapabilities (HeCapabilities hecapabilities)
 Set the HE capabilities. More...
 
void SetHeOperation (HeOperation heoperation)
 Set the HE operation. More...
 
void SetHtCapabilities (HtCapabilities htcapabilities)
 Set the HT capabilities. More...
 
void SetHtOperation (HtOperation htoperation)
 Set the HT operation. More...
 
void SetSsid (Ssid ssid)
 Set the Service Set Identifier (SSID). More...
 
void SetSupportedRates (SupportedRates rates)
 Set the supported rates. More...
 
void SetVhtCapabilities (VhtCapabilities vhtcapabilities)
 Set the VHT capabilities. More...
 
void SetVhtOperation (VhtOperation vhtoperation)
 Set the VHT operation. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. 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...
 
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

uint64_t m_beaconInterval
 Beacon interval. More...
 
CapabilityInformation m_capability
 Capability information. More...
 
CfParameterSet m_cfParameterSet
 CF parameter set. More...
 
DsssParameterSet m_dsssParameterSet
 DSSS Parameter Set. More...
 
EdcaParameterSet m_edcaParameterSet
 EDCA Parameter Set. More...
 
ErpInformation m_erpInformation
 ERP information. More...
 
ExtendedCapabilities m_extendedCapability
 extended capabilities More...
 
HeCapabilities m_heCapability
 HE capabilities. More...
 
HeOperation m_heOperation
 HE operation. More...
 
HtCapabilities m_htCapability
 HT capabilities. More...
 
HtOperation m_htOperation
 HT operation. More...
 
SupportedRates m_rates
 List of supported rates. More...
 
Ssid m_ssid
 Service set ID (SSID) More...
 
uint64_t m_timestamp
 Timestamp. More...
 
VhtCapabilities m_vhtCapability
 VHT capabilities. More...
 
VhtOperation m_vhtOperation
 VHT operation. 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 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 920 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::MgtProbeResponseHeader::MgtProbeResponseHeader ( )

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

ns3::MgtProbeResponseHeader::~MgtProbeResponseHeader ( )

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

Member Function Documentation

uint32_t ns3::MgtProbeResponseHeader::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 476 of file mgt-headers.cc.

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

+ Here is the call graph for this function:

uint64_t ns3::MgtProbeResponseHeader::GetBeaconIntervalUs ( void  ) const

Return the beacon interval in microseconds unit.

Returns
beacon interval in microseconds unit

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

Referenced by ns3::MeshWifiBeacon::GetBeaconInterval(), ns3::StaWifiMac::Receive(), and ns3::StaWifiMac::ScanningTimeout().

+ Here is the caller graph for this function:

CapabilityInformation ns3::MgtProbeResponseHeader::GetCapabilities ( void  ) const

Return the Capability information.

Returns
Capability information

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

Referenced by ns3::StaWifiMac::Receive(), ns3::StaWifiMac::UpdateApInfoFromBeacon(), and ns3::StaWifiMac::UpdateApInfoFromProbeResp().

+ Here is the caller graph for this function:

CfParameterSet ns3::MgtProbeResponseHeader::GetCfParameterSet ( void  ) const

Return the CF parameter set.

Returns
CF parameter set

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

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

+ Here is the caller graph for this function:

DsssParameterSet ns3::MgtProbeResponseHeader::GetDsssParameterSet ( void  ) const

Return the DSSS Parameter Set.

Returns
the DSSS Parameter Set

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

EdcaParameterSet ns3::MgtProbeResponseHeader::GetEdcaParameterSet ( void  ) const

Return the EDCA Parameter Set.

Returns
the EDCA Parameter Set

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

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

+ Here is the caller graph for this function:

ErpInformation ns3::MgtProbeResponseHeader::GetErpInformation ( void  ) const

Return the ERP information.

Returns
the ERP information

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

Referenced by ns3::StaWifiMac::UpdateApInfoFromBeacon(), and ns3::StaWifiMac::UpdateApInfoFromProbeResp().

+ Here is the caller graph for this function:

ExtendedCapabilities ns3::MgtProbeResponseHeader::GetExtendedCapabilities ( void  ) const

Return the extended capabilities.

Returns
the extended capabilities

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

References ns3::MgtProbeRequestHeader::m_extendedCapability.

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

+ Here is the caller graph for this function:

HeCapabilities ns3::MgtProbeResponseHeader::GetHeCapabilities ( void  ) const

Return the HE capabilities.

Returns
HE capabilities

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

References ns3::MgtProbeRequestHeader::m_heCapability.

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

+ Here is the caller graph for this function:

HeOperation ns3::MgtProbeResponseHeader::GetHeOperation ( void  ) const

Return the HE operation.

Returns
HE operation

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

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

+ Here is the caller graph for this function:

HtCapabilities ns3::MgtProbeResponseHeader::GetHtCapabilities ( void  ) const

Return the HT capabilities.

Returns
HT capabilities

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

References ns3::MgtProbeRequestHeader::m_htCapability.

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

+ Here is the caller graph for this function:

HtOperation ns3::MgtProbeResponseHeader::GetHtOperation ( void  ) const

Return the HT operation.

Returns
HT operation

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

Referenced by Bug2831TestCase::RxCallback(), and ns3::StaWifiMac::UpdateApInfoFromBeacon().

+ Here is the caller graph for this function:

TypeId ns3::MgtProbeResponseHeader::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 399 of file mgt-headers.cc.

References ns3::MgtProbeRequestHeader::GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::MgtProbeResponseHeader::GetSerializedSize ( void  ) const
virtual
Ssid ns3::MgtProbeResponseHeader::GetSsid ( void  ) const

Return the Service Set Identifier (SSID).

Returns
SSID

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

References ns3::MgtProbeRequestHeader::m_ssid.

Referenced by ns3::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

SupportedRates ns3::MgtProbeResponseHeader::GetSupportedRates ( void  ) const

Return the supported rates.

Returns
the supported rates

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

References ns3::MgtProbeRequestHeader::m_rates.

Referenced by ns3::StaWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), ns3::StaWifiMac::UpdateApInfoFromBeacon(), and ns3::StaWifiMac::UpdateApInfoFromProbeResp().

+ Here is the caller graph for this function:

uint64_t ns3::MgtProbeResponseHeader::GetTimestamp ( void  )

Return the time stamp.

Returns
time stamp

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

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

VhtCapabilities ns3::MgtProbeResponseHeader::GetVhtCapabilities ( void  ) const

Return the VHT capabilities.

Returns
VHT capabilities

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

References ns3::MgtProbeRequestHeader::m_vhtCapability.

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

+ Here is the caller graph for this function:

VhtOperation ns3::MgtProbeResponseHeader::GetVhtOperation ( void  ) const

Return the VHT operation.

Returns
VHT operation

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

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

+ Here is the caller graph for this function:

void ns3::MgtProbeResponseHeader::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 429 of file mgt-headers.cc.

References ns3::MgtProbeRequestHeader::m_extendedCapability, ns3::MgtProbeRequestHeader::m_heCapability, ns3::MgtProbeRequestHeader::m_htCapability, ns3::MgtProbeRequestHeader::m_rates, ns3::MgtProbeRequestHeader::m_ssid, and ns3::MgtProbeRequestHeader::m_vhtCapability.

void ns3::MgtProbeResponseHeader::Serialize ( Buffer::Iterator  start) const
virtual
void ns3::MgtProbeResponseHeader::SetBeaconIntervalUs ( uint64_t  us)

Set the beacon interval in microseconds unit.

Parameters
usbeacon interval in microseconds unit

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

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon().

+ Here is the caller graph for this function:

void ns3::MgtProbeResponseHeader::SetCapabilities ( CapabilityInformation  capabilities)

Set the Capability information.

Parameters
capabilitiesCapability information

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

void ns3::MgtProbeResponseHeader::SetCfParameterSet ( CfParameterSet  cfparameterset)

Set the CF parameter set.

Parameters
cfparametersetCF parameter set

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

void ns3::MgtProbeResponseHeader::SetDsssParameterSet ( DsssParameterSet  dsssParameterSet)

Set the DSSS Parameter Set.

Parameters
dsssParameterSetthe DSSS Parameter Set

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

void ns3::MgtProbeResponseHeader::SetEdcaParameterSet ( EdcaParameterSet  edcaParameterSet)

Set the EDCA Parameter Set.

Parameters
edcaParameterSetthe EDCA Parameter Set

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

void ns3::MgtProbeResponseHeader::SetErpInformation ( ErpInformation  erpInformation)

Set the ERP information.

Parameters
erpInformationthe ERP information

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

void ns3::MgtProbeResponseHeader::SetExtendedCapabilities ( ExtendedCapabilities  extendedcapabilities)

Set the extended capabilities.

Parameters
extendedcapabilitiesthe extended capabilities

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

References ns3::MgtProbeRequestHeader::m_extendedCapability.

void ns3::MgtProbeResponseHeader::SetHeCapabilities ( HeCapabilities  hecapabilities)

Set the HE capabilities.

Parameters
hecapabilitiesHE capabilities

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

References ns3::MgtProbeRequestHeader::m_heCapability.

void ns3::MgtProbeResponseHeader::SetHeOperation ( HeOperation  heoperation)

Set the HE operation.

Parameters
heoperationHE operation

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

void ns3::MgtProbeResponseHeader::SetHtCapabilities ( HtCapabilities  htcapabilities)

Set the HT capabilities.

Parameters
htcapabilitiesHT capabilities

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

References ns3::MgtProbeRequestHeader::m_htCapability.

void ns3::MgtProbeResponseHeader::SetHtOperation ( HtOperation  htoperation)

Set the HT operation.

Parameters
htoperationHT operation

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

void ns3::MgtProbeResponseHeader::SetSsid ( Ssid  ssid)

Set the Service Set Identifier (SSID).

Parameters
ssidSSID

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

References ns3::MgtProbeRequestHeader::m_ssid, and third::ssid.

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon(), ns3::ApWifiMac::SendOneBeacon(), and ns3::ApWifiMac::SendProbeResp().

+ Here is the caller graph for this function:

void ns3::MgtProbeResponseHeader::SetSupportedRates ( SupportedRates  rates)

Set the supported rates.

Parameters
ratesthe supported rates

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

References ns3::MgtProbeRequestHeader::m_rates.

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon().

+ Here is the caller graph for this function:

void ns3::MgtProbeResponseHeader::SetVhtCapabilities ( VhtCapabilities  vhtcapabilities)

Set the VHT capabilities.

Parameters
vhtcapabilitiesVHT capabilities

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

References ns3::MgtProbeRequestHeader::m_vhtCapability.

void ns3::MgtProbeResponseHeader::SetVhtOperation ( VhtOperation  vhtoperation)

Set the VHT operation.

Parameters
vhtoperationVHT operation

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

Member Data Documentation

uint64_t ns3::MgtProbeResponseHeader::m_beaconInterval
private

Beacon interval.

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

CapabilityInformation ns3::MgtProbeResponseHeader::m_capability
private

Capability information.

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

CfParameterSet ns3::MgtProbeResponseHeader::m_cfParameterSet
private

CF parameter set.

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

DsssParameterSet ns3::MgtProbeResponseHeader::m_dsssParameterSet
private

DSSS Parameter Set.

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

EdcaParameterSet ns3::MgtProbeResponseHeader::m_edcaParameterSet
private

EDCA Parameter Set.

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

ErpInformation ns3::MgtProbeResponseHeader::m_erpInformation
private

ERP information.

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

ExtendedCapabilities ns3::MgtProbeResponseHeader::m_extendedCapability
private

extended capabilities

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

HeCapabilities ns3::MgtProbeResponseHeader::m_heCapability
private

HE capabilities.

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

HeOperation ns3::MgtProbeResponseHeader::m_heOperation
private

HE operation.

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

HtCapabilities ns3::MgtProbeResponseHeader::m_htCapability
private

HT capabilities.

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

HtOperation ns3::MgtProbeResponseHeader::m_htOperation
private

HT operation.

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

SupportedRates ns3::MgtProbeResponseHeader::m_rates
private

List of supported rates.

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

Ssid ns3::MgtProbeResponseHeader::m_ssid
private

Service set ID (SSID)

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

uint64_t ns3::MgtProbeResponseHeader::m_timestamp
private

Timestamp.

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

VhtCapabilities ns3::MgtProbeResponseHeader::m_vhtCapability
private

VHT capabilities.

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

VhtOperation ns3::MgtProbeResponseHeader::m_vhtOperation
private

VHT operation.

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


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