This is plugin to Mesh WiFi MAC, which implements the interface to dot11s peer management protocol: it takes proper frames from MAC-layer, extracts peer link management information element and mesh configuration element and passes it to main part of protocol. More...

#include "peer-management-protocol-mac.h"

Inheritance diagram for ns3::dot11s::PeerManagementProtocolMac:

Collaboration diagram for ns3::dot11s::PeerManagementProtocolMac:

Classes
struct	PlinkFrameStart
	This structure keeps all fields in peer link management frame, which are not subclasses of WifiInformationElement. More...

struct	Statistics
	Statistics structure. More...

Public Member Functions
	PeerManagementProtocolMac (uint32_t interface, Ptr< PeerManagementProtocol > protocol)
	Constructor.

	~PeerManagementProtocolMac () override

int64_t	AssignStreams (int64_t stream) override
	Assign the streams.

bool	Receive (Ptr< Packet > packet, const WifiMacHeader &header) override
	Receive and process a packet.

void	SetParent (Ptr< MeshWifiInterfaceMac > parent) override
	Set pointer to parent.

void	UpdateBeacon (MeshWifiBeacon &beacon) const override
	Add beacon timing and mesh ID information elements, and notify beacon sent.

bool	UpdateOutcomingFrame (Ptr< Packet > packet, WifiMacHeader &header, Mac48Address from, Mac48Address to) override
	This method appears to test a few conditions.

Statistics
void	Report (std::ostream &) const
	Report statistics.

void	ResetStats ()
	Reset stats.

uint32_t	GetLinkMetric (Mac48Address peerAddress)
	Get the link metric.

Public Member Functions inherited from ns3::MeshWifiInterfaceMacPlugin
virtual	~MeshWifiInterfaceMacPlugin ()
	This is for subclasses.

Public Member Functions inherited from ns3::SimpleRefCount< MeshWifiInterfaceMacPlugin >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Private Member Functions
	PeerManagementProtocolMac (const PeerManagementProtocolMac &)
	type conversion operator

PeerManagementProtocolMac &	operator= (const PeerManagementProtocolMac &peer)
	assignment operator

Private Attributes
Information about MAC and protocol:
Ptr< MeshWifiInterfaceMac >	m_parent
	parent

uint32_t	m_ifIndex
	IF index.

Ptr< PeerManagementProtocol >	m_protocol
	protocol

Friends
class	PeerLink
	allow PeerLink class access friend access

class	PeerManagementProtocol
	allow PeerManagementProtocol class access friend access

Create peer link management frames
Statistics	m_stats
	statistics

Ptr< Packet >	CreatePeerLinkOpenFrame ()
	Create peer link open frame function.

Ptr< Packet >	CreatePeerLinkConfirmFrame ()
	Create peer link confirm frame function.

Ptr< Packet >	CreatePeerLinkCloseFrame ()
	Create peer link clode frame function.

PlinkFrameStart	ParsePlinkFrame (Ptr< const Packet > packet)
	Parses the start of the frame, where no WifiInformationElements exist.

void	TxError (WifiMacDropReason reason, Ptr< const WifiMpdu > mpdu)
	Closes link when a proper number of successive transmissions have failed.

void	TxOk (Ptr< const WifiMpdu > mpdu)
	Transmit OK function.

void	SetBeaconShift (Time shift)
	Set beacon shift function.

void	SetPeerManagerProtocol (Ptr< PeerManagementProtocol > protocol)
	Set peer manager protocol function.

void	SendPeerLinkManagementFrame (Mac48Address peerAddress, Mac48Address peerMpAddress, uint16_t aid, IePeerManagement peerElement, IeConfiguration meshConfig)
	Send peer link management frame function.

Mac48Address	GetAddress () const
	debug only, used to print established links

Detailed Description

This is plugin to Mesh WiFi MAC, which implements the interface to dot11s peer management protocol: it takes proper frames from MAC-layer, extracts peer link management information element and mesh configuration element and passes it to main part of protocol.

Definition at line 36 of file peer-management-protocol-mac.h.

Constructor & Destructor Documentation

◆ PeerManagementProtocolMac() [1/2]

ns3::dot11s::PeerManagementProtocolMac::PeerManagementProtocolMac	(	uint32_t	interface,
		Ptr< PeerManagementProtocol >	protocol )

Constructor.

Parameters

interface	interface index
protocol	peer management protocol

Definition at line 31 of file peer-management-protocol-mac.cc.

References m_ifIndex, and m_protocol.

◆ ~PeerManagementProtocolMac()

ns3::dot11s::PeerManagementProtocolMac::~PeerManagementProtocolMac ( )

override

Definition at line 38 of file peer-management-protocol-mac.cc.

◆ PeerManagementProtocolMac() [2/2]

ns3::dot11s::PeerManagementProtocolMac::PeerManagementProtocolMac ( const PeerManagementProtocolMac & )

private

type conversion operator

Member Function Documentation

◆ AssignStreams()

int64_t ns3::dot11s::PeerManagementProtocolMac::AssignStreams ( int64_t stream )

overridevirtual

Assign the streams.

Parameters

stream the stream to assign

Returns: the assigned stream

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 431 of file peer-management-protocol-mac.cc.

References m_protocol.

◆ CreatePeerLinkCloseFrame()

Ptr< Packet > ns3::dot11s::PeerManagementProtocolMac::CreatePeerLinkCloseFrame ( )

private

Create peer link clode frame function.

Returns: the packet

◆ CreatePeerLinkConfirmFrame()

Ptr< Packet > ns3::dot11s::PeerManagementProtocolMac::CreatePeerLinkConfirmFrame ( )

private

Create peer link confirm frame function.

Returns: the packet

◆ CreatePeerLinkOpenFrame()

Ptr< Packet > ns3::dot11s::PeerManagementProtocolMac::CreatePeerLinkOpenFrame ( )

private

Create peer link open frame function.

Returns: the packet

◆ GetAddress()

Mac48Address ns3::dot11s::PeerManagementProtocolMac::GetAddress ( ) const

private

debug only, used to print established links

Returns: the MAC address

Definition at line 349 of file peer-management-protocol-mac.cc.

References m_parent.

Referenced by ns3::dot11s::PeerLink::Report().

Here is the caller graph for this function:

◆ GetLinkMetric()

uint32_t ns3::dot11s::PeerManagementProtocolMac::GetLinkMetric ( Mac48Address peerAddress )

Get the link metric.

Parameters

peerAddress the peer address

Returns: The metric

Definition at line 425 of file peer-management-protocol-mac.cc.

References m_parent.

Referenced by ns3::dot11s::PeerLink::Report().

Here is the caller graph for this function:

◆ operator=()

PeerManagementProtocolMac & ns3::dot11s::PeerManagementProtocolMac::operator= ( const PeerManagementProtocolMac & peer )

private

assignment operator

Parameters

peer	the object to assign

Returns: the assigned value

◆ ParsePlinkFrame()

PlinkFrameStart ns3::dot11s::PeerManagementProtocolMac::ParsePlinkFrame ( Ptr< const Packet > packet )

private

Parses the start of the frame, where no WifiInformationElements exist.

Parameters

packet the packet

Returns: PlinkFrameStart

◆ Receive()

bool ns3::dot11s::PeerManagementProtocolMac::Receive	(	Ptr< Packet >	packet,
		const WifiMacHeader &	header )

overridevirtual

Receive and process a packet.

Parameters

packet	the packet received
header	the header

Returns: true if received

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 65 of file peer-management-protocol-mac.cc.

References ns3::dot11s::PeerLinkConfirmStart::PlinkConfirmStartFields::aid, ns3::dot11s::PeerManagementProtocolMac::Statistics::brokenMgt, ns3::dot11s::PeerLinkConfirmStart::PlinkConfirmStartFields::config, ns3::dot11s::PeerLinkOpenStart::PlinkOpenStartFields::config, ns3::DynamicCast(), ns3::MeshInformationElementVector::FindFirst(), ns3::WifiActionHeader::GetAction(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetAddr3(), ns3::MgtProbeResponseHeader::GetBeaconIntervalUs(), ns3::WifiActionHeader::GetCategory(), ns3::dot11s::PeerLinkCloseStart::GetFields(), ns3::dot11s::PeerLinkConfirmStart::GetFields(), ns3::dot11s::PeerLinkOpenStart::GetFields(), IE_BEACON_TIMING, IE_MESH_ID, IE_MESH_PEERING_MANAGEMENT, ns3::WifiMacHeader::IsAction(), ns3::WifiMacHeader::IsBeacon(), ns3::dot11s::IeMeshId::IsEqual(), m_ifIndex, m_parent, m_protocol, m_stats, ns3::dot11s::PeerLinkCloseStart::PlinkCloseStartFields::meshId, ns3::dot11s::PeerLinkOpenStart::PlinkOpenStartFields::meshId, ns3::MicroSeconds(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiActionHeader::PEER_LINK_CLOSE, ns3::WifiActionHeader::PEER_LINK_CONFIRM, ns3::WifiActionHeader::PEER_LINK_OPEN, ns3::dot11s::PeerManagementProtocolMac::Statistics::rxClose, ns3::dot11s::PeerManagementProtocolMac::Statistics::rxConfirm, ns3::dot11s::PeerManagementProtocolMac::Statistics::rxMgt, ns3::dot11s::PeerManagementProtocolMac::Statistics::rxMgtBytes, ns3::dot11s::PeerManagementProtocolMac::Statistics::rxOpen, ns3::WifiActionHeader::SELF_PROTECTED, and ns3::WifiActionHeader::ActionValue::selfProtectedAction.

Here is the call graph for this function:

◆ Report()

void ns3::dot11s::PeerManagementProtocolMac::Report ( std::ostream & os ) const

Report statistics.

Parameters

os	the output stream

Definition at line 409 of file peer-management-protocol-mac.cc.

References m_parent, m_stats, and ns3::dot11s::PeerManagementProtocolMac::Statistics::Print().

Here is the call graph for this function:

◆ ResetStats()

void ns3::dot11s::PeerManagementProtocolMac::ResetStats ( )

Reset stats.

Definition at line 419 of file peer-management-protocol-mac.cc.

References m_stats.

◆ SendPeerLinkManagementFrame()

void ns3::dot11s::PeerManagementProtocolMac::SendPeerLinkManagementFrame	(	Mac48Address	peerAddress,
		Mac48Address	peerMpAddress,
		uint16_t	aid,
		IePeerManagement	peerElement,
		IeConfiguration	meshConfig )

private

Send peer link management frame function.

Parameters

peerAddress	the peer MAC address
peerMpAddress	the peer MP address
aid	the AID
peerElement	IePeerManagement
meshConfig	IeConfiguration

Definition at line 267 of file peer-management-protocol-mac.cc.

Referenced by ns3::dot11s::PeerLink::SendPeerLinkClose(), ns3::dot11s::PeerLink::SendPeerLinkConfirm(), and ns3::dot11s::PeerLink::SendPeerLinkOpen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBeaconShift()

void ns3::dot11s::PeerManagementProtocolMac::SetBeaconShift ( Time shift )

private

Set beacon shift function.

Parameters

shift the beacon time shift

Definition at line 362 of file peer-management-protocol-mac.cc.

References ns3::dot11s::PeerManagementProtocolMac::Statistics::beaconShift, m_parent, m_stats, and ns3::Seconds().

Here is the call graph for this function:

◆ SetParent()

void ns3::dot11s::PeerManagementProtocolMac::SetParent ( Ptr< MeshWifiInterfaceMac > parent )

overridevirtual

Set pointer to parent.

Parameters

parent Ptr<MeshWifiInterfaceMac>

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 43 of file peer-management-protocol-mac.cc.

References m_parent, ns3::MakeCallback(), TxError(), and TxOk().

Here is the call graph for this function:

◆ SetPeerManagerProtocol()

void ns3::dot11s::PeerManagementProtocolMac::SetPeerManagerProtocol ( Ptr< PeerManagementProtocol > protocol )

private

Set peer manager protocol function.

Parameters

protocol the peer manager protocol

◆ TxError()

void ns3::dot11s::PeerManagementProtocolMac::TxError	(	WifiMacDropReason	reason,
		Ptr< const WifiMpdu >	mpdu )

private

Closes link when a proper number of successive transmissions have failed.

Parameters

reason	the reason why the MPDU was dropped
mpdu	the dropped MPDU

Definition at line 53 of file peer-management-protocol-mac.cc.

References m_ifIndex, and m_protocol.

Referenced by SetParent().

Here is the caller graph for this function:

◆ TxOk()

void ns3::dot11s::PeerManagementProtocolMac::TxOk ( Ptr< const WifiMpdu > mpdu )

private

Transmit OK function.

Parameters

mpdu the MPDU

Definition at line 59 of file peer-management-protocol-mac.cc.

References m_ifIndex, and m_protocol.

Referenced by SetParent().

Here is the caller graph for this function:

◆ UpdateBeacon()

void ns3::dot11s::PeerManagementProtocolMac::UpdateBeacon ( MeshWifiBeacon & beacon ) const

overridevirtual

Add beacon timing and mesh ID information elements, and notify beacon sent.

Parameters

beacon the beacon

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 255 of file peer-management-protocol-mac.cc.

References ns3::MeshWifiBeacon::AddInformationElement(), ns3::MeshWifiBeacon::GetBeaconInterval(), m_ifIndex, and m_protocol.

Here is the call graph for this function:

◆ UpdateOutcomingFrame()

bool ns3::dot11s::PeerManagementProtocolMac::UpdateOutcomingFrame	(	Ptr< Packet >	packet,
		WifiMacHeader &	header,
		Mac48Address	from,
		Mac48Address	to )

overridevirtual

This method appears to test a few conditions.

If an action frame, it returns true if SELF_PROTECTED. It then checks if it is either a broadcast or sent on an active link, and returns true if so. Otherwise, it returns false (indicating it is to be dropped)

Parameters