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 ()

virtual 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...

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...

HtCapabilities	GetHtCapabilities (void) const
	Return the HT capabilities. More...

HtOperations	GetHtOperations (void) const
	Return the HT operations. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

virtual 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...

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

virtual 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	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	SetHtCapabilities (HtCapabilities htcapabilities)
	Set the HT capabilities. More...

void	SetHtOperations (HtOperations htoperations)
	Set the HT operations. 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...

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

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...

DsssParameterSet	m_dsssParameterSet
	DSSS Parameter Set. More...

EdcaParameterSet	m_edcaParameterSet
	EDCA Parameter Set. More...

ErpInformation	m_erpInformation
	ERP information. More...

HtCapabilities	m_htCapability
	HT capabilities. More...

HtOperations	m_htOperations
	HT operations. 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...

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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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 624 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::MgtProbeResponseHeader::MgtProbeResponseHeader ( )

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

ns3::MgtProbeResponseHeader::~MgtProbeResponseHeader ( )

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

Member Function Documentation

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

virtual

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

References ns3::CapabilityInformation::Deserialize(), ns3::WifiInformationElement::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), m_beaconInterval, m_capability, m_dsssParameterSet, m_edcaParameterSet, m_erpInformation, m_htCapability, m_htOperations, m_rates, m_ssid, m_timestamp, m_vhtCapability, 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 177 of file mgt-headers.cc.

References m_beaconInterval.

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

Here is the caller graph for this function:

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

Return the Capability information.

Returns: Capability information

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

References m_capability.

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

References m_dsssParameterSet.

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

Return the EDCA Parameter Set.

Returns: the EDCA Parameter Set

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

References m_edcaParameterSet.

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

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

References m_erpInformation.

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

Here is the caller graph for this function:

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

Return the HT capabilities.

Returns: HT capabilities

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

References m_htCapability.

HtOperations ns3::MgtProbeResponseHeader::GetHtOperations ( void ) const

Return the HT operations.

Returns: HT operations

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

References m_htOperations.

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

References GetTypeId().

Here is the call graph for this function:

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

Here is the call graph for this function:

Ssid ns3::MgtProbeResponseHeader::GetSsid ( void ) const

Return the Service Set Identifier (SSID).

Returns: SSID

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

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

References m_rates.

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

Here is the caller graph for this function:

uint64_t ns3::MgtProbeResponseHeader::GetTimestamp ( void )

Return the time stamp.

Returns: time stamp

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

References m_timestamp.

TypeId ns3::MgtProbeResponseHeader::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

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

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

Return the VHT capabilities.

Returns: VHT capabilities

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

References m_vhtCapability.

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

virtual

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

References m_dsssParameterSet, m_erpInformation, m_htCapability, m_htOperations, m_rates, m_ssid, and m_vhtCapability.

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

virtual

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

References ns3::SupportedRates::extended, m_beaconInterval, m_capability, m_dsssParameterSet, m_edcaParameterSet, m_erpInformation, m_htCapability, m_htOperations, m_rates, m_ssid, m_vhtCapability, ns3::Simulator::Now(), ns3::DsssParameterSet::Serialize(), ns3::ExtendedSupportedRatesIE::Serialize(), ns3::ErpInformation::Serialize(), ns3::CapabilityInformation::Serialize(), ns3::VhtCapabilities::Serialize(), ns3::WifiInformationElement::Serialize(), ns3::HtCapabilities::Serialize(), ns3::HtOperations::Serialize(), ns3::EdcaParameterSet::Serialize(), visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteHtolsbU64().

Here is the call graph for this function:

void ns3::MgtProbeResponseHeader::SetBeaconIntervalUs ( uint64_t us )

Set the beacon interval in microseconds unit.

Parameters

us	beacon interval in microseconds unit

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

References m_beaconInterval.

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

Here is the caller graph for this function:

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

Set the Capability information.

Parameters

capabilities Capability information

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

References m_capability.

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

Set the DSSS Parameter Set.

Parameters

dsssParameterSet the DSSS Parameter Set

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

References m_dsssParameterSet.

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

Set the EDCA Parameter Set.

Parameters

edcaParameterSet the EDCA Parameter Set

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

References m_edcaParameterSet.

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

Set the ERP information.

Parameters

erpInformation the ERP information

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

References m_erpInformation.

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

Set the HT capabilities.

Parameters

htcapabilities HT capabilities

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

References m_htCapability.

void ns3::MgtProbeResponseHeader::SetHtOperations ( HtOperations htoperations )

Set the HT operations.

Parameters

htoperations HT operations

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

References m_htOperations.

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

Set the Service Set Identifier (SSID).

Parameters

ssid SSID

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

References 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

rates the supported rates

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

References 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

vhtcapabilities VHT capabilities

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

References m_vhtCapability.

Member Data Documentation

uint64_t ns3::MgtProbeResponseHeader::m_beaconInterval

private

Beacon interval.

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

Referenced by Deserialize(), GetBeaconIntervalUs(), Serialize(), and SetBeaconIntervalUs().

CapabilityInformation ns3::MgtProbeResponseHeader::m_capability

private

Capability information.

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

Referenced by Deserialize(), GetCapabilities(), GetSerializedSize(), Serialize(), and SetCapabilities().

DsssParameterSet ns3::MgtProbeResponseHeader::m_dsssParameterSet

private

DSSS Parameter Set.

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

Referenced by Deserialize(), GetDsssParameterSet(), GetSerializedSize(), Print(), Serialize(), and SetDsssParameterSet().

EdcaParameterSet ns3::MgtProbeResponseHeader::m_edcaParameterSet

private

EDCA Parameter Set.

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

Referenced by Deserialize(), GetEdcaParameterSet(), GetSerializedSize(), Serialize(), and SetEdcaParameterSet().

ErpInformation ns3::MgtProbeResponseHeader::m_erpInformation

private

ERP information.

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

Referenced by Deserialize(), GetErpInformation(), GetSerializedSize(), Print(), Serialize(), and SetErpInformation().

HtCapabilities ns3::MgtProbeResponseHeader::m_htCapability

private

HT capabilities.

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

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

HtOperations ns3::MgtProbeResponseHeader::m_htOperations

private

HT operations.

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

Referenced by Deserialize(), GetHtOperations(), GetSerializedSize(), Print(), Serialize(), and SetHtOperations().

SupportedRates ns3::MgtProbeResponseHeader::m_rates

private

List of supported rates.

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

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

Ssid ns3::MgtProbeResponseHeader::m_ssid

private

Service set ID (SSID)

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

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

uint64_t ns3::MgtProbeResponseHeader::m_timestamp

private

Timestamp.

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

Referenced by Deserialize(), and GetTimestamp().

VhtCapabilities ns3::MgtProbeResponseHeader::m_vhtCapability

private

VHT capabilities.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation