This class handles duplicate detection and recomposition of fragments. More...

#include "mac-rx-middle.h"

Inheritance diagram for ns3::MacRxMiddle:

Collaboration diagram for ns3::MacRxMiddle:

Public Types
typedef Callback< void, Ptr< const WifiMpdu >, uint8_t >	ForwardUpCallback
	typedef for callback More...

Public Member Functions
	MacRxMiddle ()

	~MacRxMiddle ()

void	Receive (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
	Receive an MPDU on the given link. More...

void	SetForwardCallback (ForwardUpCallback callback)
	Set a callback to forward the packet up. More...

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Private Types
typedef std::map< Mac48Address, OriginatorRxStatus *, std::less<> >	Originators
	typedef for a map between address and OriginatorRxStatus More...

typedef std::map< Mac48Address, OriginatorRxStatus *, std::less<> >::iterator	OriginatorsI
	typedef for an iterator for Originators More...

typedef std::map< std::pair< Mac48Address, uint8_t >, OriginatorRxStatus *, std::less<> >	QosOriginators
	typedef for a map between address, OriginatorRxStatus, and Traffic ID More...

typedef std::map< std::pair< Mac48Address, uint8_t >, OriginatorRxStatus *, std::less<> >::iterator	QosOriginatorsI
	typedef for an iterator for QosOriginators More...

Private Member Functions
Ptr< const Packet >	HandleFragments (Ptr< const Packet > packet, const WifiMacHeader hdr, OriginatorRxStatus originator)
	Check if the received packet is a fragment and handle it appropriately. More...

bool	IsDuplicate (const WifiMacHeader hdr, OriginatorRxStatus originator) const
	Check if we have already received the packet from the sender before (by looking at the sequence control field). More...

OriginatorRxStatus *	Lookup (const WifiMacHeader *hdr)
	Look up for OriginatorRxStatus associated with the sender address (by looking at ADDR2 field in the header). More...

Private Attributes
ForwardUpCallback	m_callback
	forward up callback More...

Originators	m_originatorStatus
	originator status More...

QosOriginators	m_qosOriginatorStatus
	QOS originator status. More...

Friends
class	MacRxMiddleTest
	allow MacRxMiddleTest associated class access More...

Detailed Description

This class handles duplicate detection and recomposition of fragments.

Definition at line 42 of file mac-rx-middle.h.

Member Typedef Documentation

◆ ForwardUpCallback

typedef Callback<void, Ptr<const WifiMpdu>, uint8_t > ns3::MacRxMiddle::ForwardUpCallback

typedef for callback

Definition at line 48 of file mac-rx-middle.h.

◆ Originators

typedef std::map<Mac48Address, OriginatorRxStatus*, std::less<> > ns3::MacRxMiddle::Originators

private

typedef for a map between address and OriginatorRxStatus

Definition at line 114 of file mac-rx-middle.h.

◆ OriginatorsI

typedef std::map<Mac48Address, OriginatorRxStatus*, std::less<> >::iterator ns3::MacRxMiddle::OriginatorsI

private

typedef for an iterator for Originators

Definition at line 123 of file mac-rx-middle.h.

◆ QosOriginators

typedef std::map<std::pair<Mac48Address, uint8_t>, OriginatorRxStatus*, std::less<> > ns3::MacRxMiddle::QosOriginators

private

typedef for a map between address, OriginatorRxStatus, and Traffic ID

Definition at line 119 of file mac-rx-middle.h.

◆ QosOriginatorsI

typedef std::map<std::pair<Mac48Address, uint8_t>, OriginatorRxStatus*, std::less<> >::iterator ns3::MacRxMiddle::QosOriginatorsI

private

typedef for an iterator for QosOriginators

Definition at line 128 of file mac-rx-middle.h.

Constructor & Destructor Documentation

◆ MacRxMiddle()

ns3::MacRxMiddle::MacRxMiddle ( )

Definition at line 162 of file mac-rx-middle.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~MacRxMiddle()

ns3::MacRxMiddle::~MacRxMiddle ( )

Definition at line 167 of file mac-rx-middle.cc.

References m_originatorStatus, m_qosOriginatorStatus, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ HandleFragments()

Ptr< const Packet > ns3::MacRxMiddle::HandleFragments	(	Ptr< const Packet >	packet,
		const WifiMacHeader *	hdr,
		OriginatorRxStatus *	originator
	)

private

Check if the received packet is a fragment and handle it appropriately.

If the packet is not a fragment, the method returns the packet. If the packet is a fragment (not the last fragment), the method initiates de-fragmentation process and return 0. If the packet is the last fragment, the method tries to re-construct the full packet and return the packet if success.

Parameters

packet	the packet
hdr	the MAC header
originator	the packet originator status

Returns: a packet if the packet is successfully reassembled (or not a fragment), 0 if we failed to reassemble the packet (e.g. missing fragments/out-of-order).

Definition at line 230 of file mac-rx-middle.cc.

References ns3::OriginatorRxStatus::AccumulateFirstFragment(), ns3::OriginatorRxStatus::AccumulateFragment(), ns3::OriginatorRxStatus::AccumulateLastFragment(), ns3::WifiMacHeader::GetFragmentNumber(), ns3::WifiMacHeader::GetSequenceControl(), ns3::WifiMacHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::WifiMacHeader::GetSize(), ns3::OriginatorRxStatus::IsDeFragmenting(), ns3::WifiMacHeader::IsMoreFragments(), ns3::OriginatorRxStatus::IsNextFragment(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::OriginatorRxStatus::SetSequenceControl().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDuplicate()

bool ns3::MacRxMiddle::IsDuplicate	(	const WifiMacHeader *	hdr,
		OriginatorRxStatus *	originator
	)		const

private

Check if we have already received the packet from the sender before (by looking at the sequence control field).

Parameters

hdr	the MAC header
originator	the packet originator status

Returns: true if we already received the packet previously, false otherwise

Definition at line 223 of file mac-rx-middle.cc.

References ns3::OriginatorRxStatus::GetLastSequenceControl(), ns3::WifiMacHeader::GetSequenceControl(), ns3::WifiMacHeader::IsRetry(), and NS_LOG_FUNCTION.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Lookup()

OriginatorRxStatus * ns3::MacRxMiddle::Lookup ( const WifiMacHeader * hdr )

private

Look up for OriginatorRxStatus associated with the sender address (by looking at ADDR2 field in the header).

The method creates a new OriginatorRxStatus if one is not already presented.

Parameters

hdr	the MAC header

Returns: OriginatorRxStatus

Definition at line 190 of file mac-rx-middle.cc.

References ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetQosTid(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsQosData(), m_originatorStatus, m_qosOriginatorStatus, and NS_LOG_FUNCTION.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Receive()

void ns3::MacRxMiddle::Receive	(	Ptr< const WifiMpdu >	mpdu,
		uint8_t	linkId
	)

Receive an MPDU on the given link.

Parameters

mpdu	the MPDU
linkId	the ID of the given link

The check below is really unneeded because it can fail in a lot of normal cases. Specifically, it is possible for sequence numbers to loop back to zero once they reach 0xfff0 and to go up to 0xf7f0 in which case the check below will report the two sequence numbers to not have the correct order relationship. So, this check cannot be used to discard old duplicate frames. It is thus here only for documentation purposes.

Definition at line 290 of file mac-rx-middle.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetFragmentNumber(), ns3::OriginatorRxStatus::GetLastSequenceControl(), ns3::WifiMacHeader::GetSequenceControl(), ns3::WifiMacHeader::GetSequenceNumber(), HandleFragments(), ns3::WifiMacHeader::IsData(), IsDuplicate(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsMgt(), Lookup(), m_callback, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::OriginatorRxStatus::SetSequenceControl().

Here is the call graph for this function:

◆ SetForwardCallback()

void ns3::MacRxMiddle::SetForwardCallback ( ForwardUpCallback callback )

Set a callback to forward the packet up.

Parameters

callback the callback to set

Definition at line 183 of file mac-rx-middle.cc.

References m_callback, and NS_LOG_FUNCTION_NOARGS.

Friends And Related Function Documentation

◆ MacRxMiddleTest

friend class MacRxMiddleTest

friend

allow MacRxMiddleTest associated class access

Definition at line 70 of file mac-rx-middle.h.

Member Data Documentation

◆ m_callback

ForwardUpCallback ns3::MacRxMiddle::m_callback

private

forward up callback

Definition at line 132 of file mac-rx-middle.h.

Referenced by Receive(), and SetForwardCallback().

◆ m_originatorStatus

Originators ns3::MacRxMiddle::m_originatorStatus

private

originator status

Definition at line 130 of file mac-rx-middle.h.

Referenced by ~MacRxMiddle(), and Lookup().

◆ m_qosOriginatorStatus

QosOriginators ns3::MacRxMiddle::m_qosOriginatorStatus

private

QOS originator status.

Definition at line 131 of file mac-rx-middle.h.

Referenced by ~MacRxMiddle(), and Lookup().

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

src/wifi/model/mac-rx-middle.h
src/wifi/model/mac-rx-middle.cc

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ForwardUpCallback

◆ Originators

◆ OriginatorsI

◆ QosOriginators

◆ QosOriginatorsI

Constructor & Destructor Documentation

◆ MacRxMiddle()

◆ ~MacRxMiddle()

Member Function Documentation

◆ HandleFragments()

◆ IsDuplicate()

◆ Lookup()

◆ Receive()

◆ SetForwardCallback()

Friends And Related Function Documentation

◆ MacRxMiddleTest

Member Data Documentation

◆ m_callback

◆ m_originatorStatus

◆ m_qosOriginatorStatus