Interface MAC plugin for HWMP – 802.11s routing protocol. More...

#include <hwmp-protocol-mac.h>

Inheritance diagram for ns3::dot11s::HwmpProtocolMac:

Collaboration diagram for ns3::dot11s::HwmpProtocolMac:

Classes
struct	MyPerr
struct	Statistics

Public Member Functions
	HwmpProtocolMac (uint32_t, Ptr< HwmpProtocol >)
	~HwmpProtocolMac ()
Inherited from MAC plugin
void	SetParent (Ptr< MeshWifiInterfaceMac > parent)
	Each plugin must be installed on interface to work.
bool	Receive (Ptr< Packet > packet, const WifiMacHeader &header)
	Process received frame.
bool	UpdateOutcomingFrame (Ptr< Packet > packet, WifiMacHeader &header, Mac48Address from, Mac48Address to)
	Update frame before it will be forwarded down.
void	UpdateBeacon (MeshWifiBeacon &beacon) const
	Update beacon is empty, because HWMP does not know anything about beacons.
int64_t	AssignStreams (int64_t stream)
Public Member Functions inherited from ns3::MeshWifiInterfaceMacPlugin
virtual	~MeshWifiInterfaceMacPlugin ()
	This is for subclasses.
Public Member Functions inherited from ns3::SimpleRefCount< MeshWifiInterfaceMacPlugin >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const

Private Member Functions
uint16_t	GetChannelId () const
uint32_t	GetLinkMetric (Mac48Address peerAddress) const
bool	ReceiveAction (Ptr< Packet > packet, const WifiMacHeader &header)
	Receive action management frame.
bool	ReceiveData (Ptr< Packet > packet, const WifiMacHeader &header)
	Receive data frame.
void	Report (std::ostream &) const
	Report statistics.
void	ResetStats ()
void	SendMyPerr ()
void	SendMyPreq ()
	Sends one PREQ when PreqMinInterval after last PREQ expires (if any PREQ exists in rhe queue)
Interaction with HWMP:
void	SendPreq (IePreq preq)
void	SendPreq (std::vector< IePreq > preq)
void	SendPrep (IePrep prep, Mac48Address receiver)
void	ForwardPerr (std::vector< HwmpProtocol::FailedDestination > destinations, std::vector< Mac48Address > receivers)
void	InitiatePerr (std::vector< HwmpProtocol::FailedDestination > destinations, std::vector< Mac48Address > receivers)
void	RequestDestination (Mac48Address dest, uint32_t originator_seqno, uint32_t dst_seqno)
	Request a destination. If can not send preq immediately - add a destination to existing PREQ generated by me and stored in PREQ queue.

Static Private Member Functions
static WifiActionHeader	GetWifiActionHeader ()

Private Attributes
uint32_t	m_ifIndex
Ptr< MeshWifiInterfaceMac >	m_parent
Ptr< HwmpProtocol >	m_protocol
my PREQ and PREQ timer:
EventId	m_preqTimer
std::vector< IePreq >	m_myPreq
PERR timer and stored path error
EventId	m_perrTimer
MyPerr	m_myPerr
Statistics:
Statistics	m_stats

Friends
class	HwmpProtocol

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< MeshWifiInterfaceMacPlugin >
static void	Cleanup (void)

Detailed Description

Interface MAC plugin for HWMP – 802.11s routing protocol.

Definition at line 44 of file hwmp-protocol-mac.h.

Constructor & Destructor Documentation

ns3::dot11s::HwmpProtocolMac::HwmpProtocolMac	(	uint32_t	ifIndex,
		Ptr< HwmpProtocol >	protocol
	)

Definition at line 39 of file hwmp-protocol-mac.cc.

ns3::dot11s::HwmpProtocolMac::~HwmpProtocolMac ( )

Definition at line 43 of file hwmp-protocol-mac.cc.

Member Function Documentation

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

virtual

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 480 of file hwmp-protocol-mac.cc.

References ns3::dot11s::HwmpProtocol::AssignStreams(), and m_protocol.

Here is the call graph for this function:

void ns3::dot11s::HwmpProtocolMac::ForwardPerr	(	std::vector< HwmpProtocol::FailedDestination >	destinations,
		std::vector< Mac48Address >	receivers
	)

private

Definition at line 319 of file hwmp-protocol-mac.cc.

References ns3::Packet::AddHeader(), ns3::WifiInformationElementVector::AddInformationElement(), ns3::RegularWifiMac::GetAddress(), ns3::dot11s::HwmpProtocol::GetAddress(), ns3::Mac48Address::GetBroadcast(), ns3::Packet::GetSize(), ns3::dot11s::HwmpProtocol::GetUnicastPerrThreshold(), GetWifiActionHeader(), m_parent, m_protocol, m_stats, NS_LOG_FUNCTION_NOARGS, ns3::MeshWifiInterfaceMac::SendManagementFrame(), ns3::WifiMacHeader::SetAction(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::dot11s::HwmpProtocolMac::Statistics::txMgt, ns3::dot11s::HwmpProtocolMac::Statistics::txMgtBytes, and ns3::dot11s::HwmpProtocolMac::Statistics::txPerr.

Referenced by SendMyPerr().

Here is the call graph for this function:

Here is the caller graph for this function:

uint16_t ns3::dot11s::HwmpProtocolMac::GetChannelId ( ) const

private

Definition at line 437 of file hwmp-protocol-mac.cc.

References ns3::MeshWifiInterfaceMac::GetFrequencyChannel(), and m_parent.

Here is the call graph for this function:

uint32_t ns3::dot11s::HwmpProtocolMac::GetLinkMetric ( Mac48Address peerAddress ) const

private

Returns: metric to HWMP protocol, needed only by metrics to add

Definition at line 432 of file hwmp-protocol-mac.cc.

References ns3::MeshWifiInterfaceMac::GetLinkMetric(), and m_parent.

Here is the call graph for this function:

WifiActionHeader ns3::dot11s::HwmpProtocolMac::GetWifiActionHeader ( )

staticprivate

Returns: a path selection action header

Definition at line 207 of file hwmp-protocol-mac.cc.

References ns3::WifiActionHeader::MESH_PATH_SELECTION, ns3::WifiActionHeader::PATH_SELECTION, ns3::WifiActionHeader::ActionValue::pathSelection, and ns3::WifiActionHeader::SetAction().

Referenced by ForwardPerr(), SendPrep(), and SendPreq().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dot11s::HwmpProtocolMac::InitiatePerr	(	std::vector< HwmpProtocol::FailedDestination >	destinations,
		std::vector< Mac48Address >	receivers
	)

private

Definition at line 373 of file hwmp-protocol-mac.cc.

References ns3::dot11s::HwmpProtocolMac::MyPerr::destinations, m_myPerr, ns3::dot11s::HwmpProtocolMac::MyPerr::receivers, and SendMyPerr().

Here is the call graph for this function:

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

virtual

Process received frame.

Returns: false if (and only if) frame should be dropped TODO define when MAC call this

Implements ns3::MeshWifiInterfaceMacPlugin.

Definition at line 165 of file hwmp-protocol-mac.cc.

References ns3::WifiMacHeader::IsAction(), ns3::WifiMacHeader::IsData(), ReceiveAction(), and ReceiveData().

Here is the call graph for this function:

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

private

Receive action management frame.

Definition at line 94 of file hwmp-protocol-mac.cc.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

Receive data frame.

Definition at line 53 of file hwmp-protocol-mac.cc.

References ns3::Packet::AddPacketTag(), ns3::dot11s::HwmpProtocol::DropDataFrame(), ns3::WifiMacHeader::GetAddr3(), ns3::WifiMacHeader::GetAddr4(), ns3::Mac48Address::GetBroadcast(), ns3::Packet::GetSize(), ns3::WifiMacHeader::IsData(), m_protocol, m_stats, NS_ASSERT, NS_FATAL_ERROR, ns3::Packet::PeekPacketTag(), ns3::Packet::RemoveHeader(), ns3::dot11s::HwmpProtocolMac::Statistics::rxData, ns3::dot11s::HwmpProtocolMac::Statistics::rxDataBytes, ns3::dot11s::HwmpTag::SetSeqno(), and ns3::dot11s::HwmpTag::SetTtl().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

Report statistics.

Definition at line 466 of file hwmp-protocol-mac.cc.

References ns3::RegularWifiMac::GetAddress(), m_parent, m_stats, and ns3::dot11s::HwmpProtocolMac::Statistics::Print().

Here is the call graph for this function:

void ns3::dot11s::HwmpProtocolMac::RequestDestination	(	Mac48Address	dest,
		uint32_t	originator_seqno,
		uint32_t	dst_seqno
	)

private

Request a destination. If can not send preq immediately - add a destination to existing PREQ generated by me and stored in PREQ queue.

Parameters

dest	is the destination to be resolved
originator_seqno	is a sequence number that shall be preq originator sequenece number
dst_seqno	is a sequence number taken from routing table

Definition at line 253 of file hwmp-protocol-mac.cc.

References ns3::dot11s::IePreq::AddDestinationAddressElement(), ns3::dot11s::HwmpProtocol::GetActivePathLifetime(), ns3::dot11s::HwmpProtocol::GetAddress(), ns3::dot11s::HwmpProtocol::GetDoFlag(), ns3::dot11s::HwmpProtocol::GetMaxTtl(), ns3::dot11s::HwmpProtocol::GetNextPreqId(), ns3::dot11s::HwmpProtocol::GetRfFlag(), m_myPreq, m_protocol, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, SendMyPreq(), ns3::dot11s::IePreq::SetHopcount(), ns3::dot11s::IePreq::SetLifetime(), ns3::dot11s::IePreq::SetOriginatorAddress(), ns3::dot11s::IePreq::SetOriginatorSeqNumber(), ns3::dot11s::IePreq::SetPreqID(), and ns3::dot11s::IePreq::SetTTL().