Class that implements the LR-WPAN Mac state machine. More...

#include "lr-wpan-mac.h"

Inheritance diagram for ns3::LrWpanMac:

Classes
struct	TxQueueElement
	Helper structure for managing transmission queue elements. More...

Public Types
typedef void(*	SentTracedCallback) (Ptr< const Packet > packet, uint8_t retries, uint8_t backoffs)
	TracedCallback signature for sent packets. More...

typedef void(*	StateTracedCallback) (LrWpanMacState oldState, LrWpanMacState newState)
	TracedCallback signature for LrWpanMacState change events. More...

Public Member Functions
	LrWpanMac (void)
	Default constructor. More...

virtual	~LrWpanMac (void)

LrWpanAssociationStatus	GetAssociationStatus (void) const
	Get the current association status. More...

Mac64Address	GetExtendedAddress (void) const
	Get the extended address of this MAC. More...

uint64_t	GetMacAckWaitDuration (void) const
	Get the macAckWaitDuration attribute value. More...

uint8_t	GetMacMaxFrameRetries (void) const
	Get the macMaxFrameRetries attribute value. More...

uint16_t	GetPanId (void) const
	Get the PAN id used by this MAC. More...

Ptr< LrWpanPhy >	GetPhy (void)
	Get the underlying PHY of the MAC. More...

bool	GetRxOnWhenIdle (void)
	Check if the receiver will be enabled when the MAC is idle. More...

Mac16Address	GetShortAddress (void) const
	Get the short address of this MAC. More...

void	McpsDataRequest (McpsDataRequestParams params, Ptr< Packet > p)
	IEEE 802.15.4-2006, section 7.1.1.1 MCPS-DATA.request Request to transfer a MSDU. More...

void	PdDataConfirm (LrWpanPhyEnumeration status)
	IEEE 802.15.4-2006 section 6.2.1.2 Confirm the end of transmission of an MPDU to MAC. More...

void	PdDataIndication (uint32_t psduLength, Ptr< Packet > p, uint8_t lqi)
	IEEE 802.15.4-2006 section 6.2.1.3 PD-DATA.indication Indicates the transfer of an MPDU from PHY to MAC (receiving) More...

void	PlmeCcaConfirm (LrWpanPhyEnumeration status)
	IEEE 802.15.4-2006 section 6.2.2.2 PLME-CCA.confirm status. More...

void	PlmeEdConfirm (LrWpanPhyEnumeration status, uint8_t energyLevel)
	IEEE 802.15.4-2006 section 6.2.2.4 PLME-ED.confirm status and energy level. More...

void	PlmeGetAttributeConfirm (LrWpanPhyEnumeration status, LrWpanPibAttributeIdentifier id, LrWpanPhyPibAttributes *attribute)
	IEEE 802.15.4-2006 section 6.2.2.6 PLME-GET.confirm Get attributes per definition from Table 23 in section 6.4.2. More...

void	PlmeSetAttributeConfirm (LrWpanPhyEnumeration status, LrWpanPibAttributeIdentifier id)
	IEEE 802.15.4-2006 section 6.2.2.10 PLME-SET.confirm Set attributes per definition from Table 23 in section 6.4.2. More...

void	PlmeSetTRXStateConfirm (LrWpanPhyEnumeration status)
	IEEE 802.15.4-2006 section 6.2.2.8 PLME-SET-TRX-STATE.confirm Set PHY state. More...

void	SetAssociationStatus (LrWpanAssociationStatus status)
	Set the current association status. More...

void	SetCsmaCa (Ptr< LrWpanCsmaCa > csmaCa)
	Set the CSMA/CA implementation to be used by the MAC. More...

void	SetExtendedAddress (Mac64Address address)
	Set the extended address of this MAC. More...

void	SetLrWpanMacState (LrWpanMacState macState)
	CSMA-CA algorithm calls back the MAC after executing channel assessment. More...

void	SetMacMaxFrameRetries (uint8_t retries)
	Set the macMaxFrameRetries attribute value. More...

void	SetMcpsDataConfirmCallback (McpsDataConfirmCallback c)
	Set the callback for the confirmation of a data transmission request. More...

void	SetMcpsDataIndicationCallback (McpsDataIndicationCallback c)
	Set the callback for the indication of an incoming data packet. More...

void	SetPanId (uint16_t panId)
	Set the PAN id used by this MAC. More...

void	SetPhy (Ptr< LrWpanPhy > phy)
	Set the underlying PHY for the MAC. More...

void	SetRxOnWhenIdle (bool rxOnWhenIdle)
	Set if the receiver should be enabled when the MAC is idle. More...

void	SetShortAddress (Mac16Address address)
	Set the short address of this MAC. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

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

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

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

void	Unref (void) const
	Decrement the reference count. 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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Public Attributes
uint64_t	m_aBaseSlotDuration
	Length of a superframe slot in symbols. More...

uint64_t	m_aBaseSuperframeDuration
	Length of a superframe in symbols. More...

uint64_t	m_aNumSuperframeSlots
	Number of a superframe slots per superframe. More...

uint64_t	m_macBeaconOrder
	Specification of how often the coordinator transmits its beacon. More...

uint64_t	m_macBeaconTxTime
	The time that the device transmitted its last beacon frame, in symbol periods. More...

SequenceNumber8	m_macDsn
	Sequence number added to transmitted data or MAC command frame, 00-ff. More...

uint8_t	m_macMaxFrameRetries
	The maximum number of retries allowed after a transmission failure. More...

uint16_t	m_macPanId
	16 bits id of PAN on which this device is operating. More...

bool	m_macPromiscuousMode
	Indicates if MAC sublayer is in receive all mode. More...

bool	m_macRxOnWhenIdle
	Indication of whether the MAC sublayer is to enable its receiver during idle periods. More...

uint64_t	m_macSuperframeOrder
	The length of the active portion of the outgoing superframe, including the beacon frame. More...

uint64_t	m_macSyncSymbolOffset
	Symbol boundary is same as m_macBeaconTxTime. More...

Static Public Attributes
static const uint32_t	aMinMPDUOverhead = 9
	The minimum number of octets added by the MAC sublayer to the PSDU. More...

Protected Member Functions
virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

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

Private Member Functions
void	AckWaitTimeout (void)
	Handle an ACK timeout with a packet retransmission, if there are retransmission left, or a packet drop. More...

void	ChangeMacState (LrWpanMacState newState)
	Change the current MAC state to the given new state. More...

void	CheckQueue (void)
	Check the transmission queue. More...

bool	PrepareRetransmission (void)
	Check for remaining retransmissions for the packet currently being sent. More...

void	RemoveFirstTxQElement ()
	Remove the tip of the transmission queue, including clean up related to the last packet transmission. More...

void	SendAck (uint8_t seqno)
	Send an acknowledgment packet for the given sequence number. More...

Private Attributes
EventId	m_ackWaitTimeout
	Scheduler event for the ACK timeout of the currently transmitted data packet. More...

LrWpanAssociationStatus	m_associationStatus
	The current association status of the MAC layer. More...

Ptr< LrWpanCsmaCa >	m_csmaCa
	The CSMA/CA implementation used by this MAC. More...

TracedValue< LrWpanMacState >	m_lrWpanMacState
	The current state of the MAC layer. More...

TracedCallback< Ptr< const Packet > >	m_macPromiscRxTrace
	The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...

TracedCallback< Ptr< const Packet > >	m_macRxDropTrace
	The trace source fired for packets successfully received by the device but dropped before being forwarded up to higher layers (at the L2/L3 transition). More...

TracedCallback< Ptr< const Packet > >	m_macRxTrace
	The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...

TracedCallback< LrWpanMacState, LrWpanMacState >	m_macStateLogger
	A trace source that fires when the LrWpanMac changes states. More...

TracedCallback< Ptr< const Packet > >	m_macTxDequeueTrace
	The trace source fired when packets are dequeued from the L3/l2 transmission queue. More...

TracedCallback< Ptr< const Packet > >	m_macTxDropTrace
	The trace source fired when packets are dropped due to missing ACKs or because of transmission failures in L1. More...

TracedCallback< Ptr< const Packet > >	m_macTxEnqueueTrace
	The trace source fired when packets come into the "top" of the device at the L3/L2 transition, when being queued for transmission. More...

TracedCallback< Ptr< const Packet > >	m_macTxOkTrace
	The trace source fired when packets where successfully transmitted, that is an acknowledgment was received, if requested, or the packet was successfully sent by L1, if no ACK was requested. More...

TracedCallback< Ptr< const Packet > >	m_macTxTrace
	The trace source fired when packets are being sent down to L1. More...

McpsDataConfirmCallback	m_mcpsDataConfirmCallback
	This callback is used to report data transmission request status to the upper layers. More...

McpsDataIndicationCallback	m_mcpsDataIndicationCallback
	This callback is used to notify incoming packets to the upper layers. More...

uint8_t	m_numCsmacaRetry
	The number of CSMA/CA retries used for sending the current packet. More...

Ptr< LrWpanPhy >	m_phy
	The PHY associated with this MAC. More...

TracedCallback< Ptr< const Packet > >	m_promiscSnifferTrace
	A trace source that emulates a promiscuous mode protocol sniffer connected to the device. More...

uint8_t	m_retransmission
	The number of already used retransmission for the currently transmitted packet. More...

Mac64Address	m_selfExt
	The extended address used by this MAC. More...

TracedCallback< Ptr< const Packet >, uint8_t, uint8_t >	m_sentPktTrace
	The trace source fired when packets are considered as successfully sent or the transmission has been given up. More...

EventId	m_setMacState
	Scheduler event for a deferred MAC state change. More...

Mac16Address	m_shortAddress
	The short address used by this MAC. More...

TracedCallback< Ptr< const Packet > >	m_snifferTrace
	A trace source that emulates a non-promiscuous protocol sniffer connected to the device. More...

Ptr< Packet >	m_txPkt
	The packet which is currently being sent by the MAC layer. More...

std::deque< TxQueueElement * >	m_txQueue
	The transmit queue used by the MAC. More...

Additional Inherited Members
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

Class that implements the LR-WPAN Mac state machine.

Config Paths

ns3::LrWpanMac is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Mac"

Attributes

PanId: 16-bit identifier of the associated PAN
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: construct write read

TraceSources

MacTxEnqueue: Trace source indicating a packet has been enqueued in the transaction queue
Callback signature: ns3::Packet::TracedCallback
MacTxDequeue: Trace source indicating a packet has was dequeued from the transaction queue
Callback signature: ns3::Packet::TracedCallback
MacTx: Trace source indicating a packet has arrived for transmission by this device
Callback signature: ns3::Packet::TracedCallback
MacTxOk: Trace source indicating a packet has been successfully sent
Callback signature: ns3::Packet::TracedCallback
MacTxDrop: Trace source indicating a packet has been dropped during transmission
Callback signature: ns3::Packet::TracedCallback
MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
Callback signature: ns3::Packet::TracedCallback
MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
Callback signature: ns3::Packet::TracedCallback
MacRxDrop: Trace source indicating a packet was received, but dropped before being forwarded up the stack
Callback signature: ns3::Packet::TracedCallback
Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback
PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback
MacStateValue: The state of LrWpan Mac
Callback signature: ns3::TracedValueCallback::LrWpanMacState
MacState: The state of LrWpan Mac
Callback signature: ns3::LrWpanMac::StateTracedCallback
MacSentPkt: Trace source reporting some information about the sent packet
Callback signature: ns3::LrWpanMac::SentTracedCallback

Size of this type is 584 bytes (on a 64-bit architecture).

Definition at line 222 of file lr-wpan-mac.h.

Member Typedef Documentation

◆ SentTracedCallback

typedef void(* ns3::LrWpanMac::SentTracedCallback) (Ptr< const Packet > packet, uint8_t retries, uint8_t backoffs)

TracedCallback signature for sent packets.

Parameters

[in]	packet	The packet.
[in]	retries	The number of retries.
[in]	backoffs	The number of CSMA backoffs.

Definition at line 547 of file lr-wpan-mac.h.

◆ StateTracedCallback

typedef void(* ns3::LrWpanMac::StateTracedCallback) (LrWpanMacState oldState, LrWpanMacState newState)

TracedCallback signature for LrWpanMacState change events.

Parameters

[in]	oldValue	The original state value.
[in]	newValue	The new state value.

Deprecated:: The LrWpanMacState is now accessible as the TracedValue MacStateValue. The MacState TracedCallback will be removed in a future release.

Definition at line 559 of file lr-wpan-mac.h.

Constructor & Destructor Documentation

◆ LrWpanMac()

ns3::LrWpanMac::LrWpanMac ( void )

Default constructor.

Definition at line 131 of file lr-wpan-mac.cc.

References ns3::Mac64Address::Allocate(), ns3::ASSOCIATED, ChangeMacState(), ns3::UniformRandomVariable::GetValue(), m_associationStatus, m_lrWpanMacState, m_macDsn, m_macMaxFrameRetries, m_macPanId, m_macPromiscuousMode, m_macRxOnWhenIdle, m_numCsmacaRetry, m_retransmission, m_selfExt, m_shortAddress, m_txPkt, ns3::MAC_IDLE, and ns3::ObjectBase::SetAttribute().

◆ ~LrWpanMac()

ns3::LrWpanMac::~LrWpanMac ( void )

virtual

Definition at line 155 of file lr-wpan-mac.cc.

Member Function Documentation

◆ AckWaitTimeout()

void ns3::LrWpanMac::AckWaitTimeout ( void )

private

Handle an ACK timeout with a packet retransmission, if there are retransmission left, or a packet drop.

Definition at line 773 of file lr-wpan-mac.cc.

References ns3::MAC_CSMA, ns3::MAC_IDLE, NS_LOG_FUNCTION, PrepareRetransmission(), and SetLrWpanMacState().

Referenced by PdDataConfirm().

◆ ChangeMacState()

void ns3::LrWpanMac::ChangeMacState ( LrWpanMacState newState )

private

Change the current MAC state to the given new state.

Parameters

newState the new state

Definition at line 1054 of file lr-wpan-mac.cc.

References m_lrWpanMacState, m_macStateLogger, and NS_LOG_LOGIC().

Referenced by LrWpanMac(), PdDataIndication(), SendAck(), and SetLrWpanMacState().

◆ CheckQueue()

void ns3::LrWpanMac::CheckQueue ( void )

private

Check the transmission queue.

If there are packets in the transmission queue and the MAC is idle, pick the first one and initiate a packet transmission.

Definition at line 447 of file lr-wpan-mac.cc.

References ns3::EventId::IsRunning(), m_lrWpanMacState, m_setMacState, m_txPkt, m_txQueue, ns3::MAC_CSMA, ns3::MAC_IDLE, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), SetLrWpanMacState(), and ns3::LrWpanMac::TxQueueElement::txQPkt.

Referenced by McpsDataRequest(), and SetLrWpanMacState().

◆ DoDispose()

void ns3::LrWpanMac::DoDispose ( void )

protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 175 of file lr-wpan-mac.cc.

References ns3::Object::DoDispose(), m_csmaCa, m_mcpsDataConfirmCallback, m_mcpsDataIndicationCallback, m_phy, m_txPkt, and m_txQueue.

◆ DoInitialize()

void ns3::LrWpanMac::DoInitialize ( void )

protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 160 of file lr-wpan-mac.cc.

References ns3::Object::DoInitialize(), ns3::IEEE_802_15_4_PHY_RX_ON, ns3::IEEE_802_15_4_PHY_TRX_OFF, m_macRxOnWhenIdle, and m_phy.

◆ GetAssociationStatus()

LrWpanAssociationStatus ns3::LrWpanMac::GetAssociationStatus ( void ) const

Get the current association status.

Returns: current association status

Definition at line 1030 of file lr-wpan-mac.cc.

References m_associationStatus.

◆ GetExtendedAddress()

Mac64Address ns3::LrWpanMac::GetExtendedAddress ( void ) const

Get the extended address of this MAC.

Returns: the extended address

Definition at line 244 of file lr-wpan-mac.cc.

References m_selfExt, and NS_LOG_FUNCTION.

Referenced by McpsDataRequest().

◆ GetMacAckWaitDuration()

uint64_t ns3::LrWpanMac::GetMacAckWaitDuration ( void ) const

Get the macAckWaitDuration attribute value.

Returns: the maximum number symbols to wait for an acknowledgment frame

Definition at line 1064 of file lr-wpan-mac.cc.

References m_csmaCa, and m_phy.

Referenced by PdDataConfirm().

◆ GetMacMaxFrameRetries()

uint8_t ns3::LrWpanMac::GetMacMaxFrameRetries ( void ) const

Get the macMaxFrameRetries attribute value.

Returns: the maximum number of retries

Definition at line 1071 of file lr-wpan-mac.cc.

References m_macMaxFrameRetries.

◆ GetPanId()

uint16_t ns3::LrWpanMac::GetPanId ( void ) const

Get the PAN id used by this MAC.

Returns: the PAN id.

Definition at line 1042 of file lr-wpan-mac.cc.

References m_macPanId.

Referenced by McpsDataRequest().

◆ GetPhy()

Ptr< LrWpanPhy > ns3::LrWpanMac::GetPhy ( void )

Get the underlying PHY of the MAC.

Returns: the PHY

Definition at line 473 of file lr-wpan-mac.cc.

References m_phy.

◆ GetRxOnWhenIdle()

bool ns3::LrWpanMac::GetRxOnWhenIdle ( void )

Check if the receiver will be enabled when the MAC is idle.

Returns: true, if the receiver is enabled during idle periods, false otherwise

Definition at line 197 of file lr-wpan-mac.cc.

References m_macRxOnWhenIdle.

◆ GetShortAddress()

Mac16Address ns3::LrWpanMac::GetShortAddress ( void ) const

Get the short address of this MAC.

Returns: the short address

Definition at line 237 of file lr-wpan-mac.cc.

References m_shortAddress, and NS_LOG_FUNCTION.

Referenced by McpsDataRequest().

◆ GetTypeId()

TypeId ns3::LrWpanMac::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 50 of file lr-wpan-mac.cc.

References m_lrWpanMacState, m_macPanId, m_macPromiscRxTrace, m_macRxDropTrace, m_macRxTrace, m_macStateLogger, m_macTxDequeueTrace, m_macTxDropTrace, m_macTxEnqueueTrace, m_macTxOkTrace, m_macTxTrace, m_promiscSnifferTrace, m_sentPktTrace, m_snifferTrace, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

◆ McpsDataRequest()

void ns3::LrWpanMac::McpsDataRequest	(	McpsDataRequestParams	params,
		Ptr< Packet >	p
	)

IEEE 802.15.4-2006, section 7.1.1.1 MCPS-DATA.request Request to transfer a MSDU.

Parameters

params	the request parameters
p	the packet to be transmitted

Definition at line 250 of file lr-wpan-mac.cc.

References ns3::Packet::AddHeader(), ns3::ADDR_MODE_RESERVED, ns3::Packet::AddTrailer(), ns3::LrWpanPhy::aMaxPhyPacketSize, aMinMPDUOverhead, CheckQueue(), ns3::Node::ChecksumEnabled(), ns3::LrWpanMacTrailer::EnableFcs(), ns3::EXT_ADDR, GetExtendedAddress(), GetPanId(), GetShortAddress(), ns3::Packet::GetSize(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), ns3::IEEE_802_15_4_FRAME_TOO_LONG, ns3::IEEE_802_15_4_INVALID_ADDRESS, ns3::IEEE_802_15_4_INVALID_PARAMETER, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), ns3::LrWpanMacHeader::LRWPAN_MAC_DATA, m_csmaCa, ns3::McpsDataRequestParams::m_dstAddr, ns3::McpsDataRequestParams::m_dstAddrMode, ns3::McpsDataRequestParams::m_dstExtAddr, ns3::McpsDataRequestParams::m_dstPanId, m_macDsn, m_macTxEnqueueTrace, m_mcpsDataConfirmCallback, ns3::McpsDataRequestParams::m_msduHandle, ns3::McpsDataConfirmParams::m_msduHandle, ns3::McpsDataRequestParams::m_srcAddrMode, ns3::McpsDataConfirmParams::m_status, ns3::McpsDataRequestParams::m_txOptions, m_txQueue, ns3::NO_PANID_ADDR, NS_ABORT_MSG, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::LrWpanMacTrailer::SetFcs(), ns3::SHORT_ADDR, ns3::TX_OPTION_ACK, ns3::TX_OPTION_GTS, ns3::TX_OPTION_INDIRECT, ns3::LrWpanMac::TxQueueElement::txQMsduHandle, and ns3::LrWpanMac::TxQueueElement::txQPkt.

◆ PdDataConfirm()

void ns3::LrWpanMac::PdDataConfirm ( LrWpanPhyEnumeration status )

IEEE 802.15.4-2006 section 6.2.1.2 Confirm the end of transmission of an MPDU to MAC.

Parameters

status to report to MAC PHY PD-DATA.confirm status

Definition at line 821 of file lr-wpan-mac.cc.

References AckWaitTimeout(), ns3::EventId::Cancel(), GetMacAckWaitDuration(), ns3::IEEE_802_15_4_FRAME_TOO_LONG, ns3::IEEE_802_15_4_PHY_SUCCESS, ns3::IEEE_802_15_4_PHY_UNSPECIFIED, ns3::IEEE_802_15_4_SUCCESS, ns3::EventId::IsExpired(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_ackWaitTimeout, m_lrWpanMacState, m_macTxDropTrace, m_macTxOkTrace, m_mcpsDataConfirmCallback, ns3::McpsDataConfirmParams::m_msduHandle, m_phy, m_setMacState, ns3::McpsDataConfirmParams::m_status, m_txPkt, m_txQueue, ns3::MAC_ACK_PENDING, ns3::MAC_IDLE, ns3::MAC_SENDING, ns3::MicroSeconds(), NS_ASSERT, NS_ASSERT_MSG(), NS_FATAL_ERROR, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Packet::PeekHeader(), RemoveFirstTxQElement(), ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), and SetLrWpanMacState().

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PdDataIndication()

void ns3::LrWpanMac::PdDataIndication	(	uint32_t	psduLength,
		Ptr< Packet >	p,
		uint8_t	lqi
	)

IEEE 802.15.4-2006 section 6.2.1.3 PD-DATA.indication Indicates the transfer of an MPDU from PHY to MAC (receiving)

Parameters

psduLength	number of bytes in the PSDU
p	the packet to be transmitted
lqi	Link quality (LQI) value measured during reception of the PPDU

Definition at line 491 of file lr-wpan-mac.cc.

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PlmeCcaConfirm()

void ns3::LrWpanMac::PlmeCcaConfirm ( LrWpanPhyEnumeration status )

IEEE 802.15.4-2006 section 6.2.2.2 PLME-CCA.confirm status.

Parameters

status TRX_OFF, BUSY or IDLE

Definition at line 902 of file lr-wpan-mac.cc.

References m_csmaCa, and NS_LOG_FUNCTION.

◆ PlmeEdConfirm()

void ns3::LrWpanMac::PlmeEdConfirm	(	LrWpanPhyEnumeration	status,
		uint8_t	energyLevel
	)

IEEE 802.15.4-2006 section 6.2.2.4 PLME-ED.confirm status and energy level.

Parameters

status	SUCCESS, TRX_OFF or TX_ON
energyLevel	0x00-0xff ED level for the channel

Definition at line 910 of file lr-wpan-mac.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PlmeGetAttributeConfirm()

void ns3::LrWpanMac::PlmeGetAttributeConfirm	(	LrWpanPhyEnumeration	status,
		LrWpanPibAttributeIdentifier	id,
		LrWpanPhyPibAttributes *	attribute
	)

IEEE 802.15.4-2006 section 6.2.2.6 PLME-GET.confirm Get attributes per definition from Table 23 in section 6.4.2.

Parameters

status	SUCCESS or UNSUPPORTED_ATTRIBUTE
id	the attributed identifier
attribute	the attribute value

Definition at line 917 of file lr-wpan-mac.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PlmeSetAttributeConfirm()

void ns3::LrWpanMac::PlmeSetAttributeConfirm	(	LrWpanPhyEnumeration	status,
		LrWpanPibAttributeIdentifier	id
	)

IEEE 802.15.4-2006 section 6.2.2.10 PLME-SET.confirm Set attributes per definition from Table 23 in section 6.4.2.

Parameters

status	SUCCESS, UNSUPPORTED_ATTRIBUTE, INVALID_PARAMETER, or READ_ONLY
id	the attributed identifier

Definition at line 963 of file lr-wpan-mac.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PlmeSetTRXStateConfirm()

void ns3::LrWpanMac::PlmeSetTRXStateConfirm ( LrWpanPhyEnumeration status )

IEEE 802.15.4-2006 section 6.2.2.8 PLME-SET-TRX-STATE.confirm Set PHY state.

Parameters

status in RX_ON,TRX_OFF,FORCE_TRX_OFF,TX_ON

Definition at line 925 of file lr-wpan-mac.cc.

References ns3::Packet::GetSize(), ns3::IEEE_802_15_4_PHY_RX_ON, ns3::IEEE_802_15_4_PHY_SUCCESS, ns3::IEEE_802_15_4_PHY_TRX_OFF, ns3::IEEE_802_15_4_PHY_TX_ON, m_csmaCa, m_lrWpanMacState, m_macTxTrace, m_phy, m_promiscSnifferTrace, m_snifferTrace, m_txPkt, ns3::MAC_ACK_PENDING, ns3::MAC_CSMA, ns3::MAC_IDLE, ns3::MAC_SENDING, NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::LrWpanNetDevice::CompleteConfig().

◆ PrepareRetransmission()

bool ns3::LrWpanMac::PrepareRetransmission ( void )

private

Check for remaining retransmissions for the packet currently being sent.

Drop the packet, if there are no retransmissions left.

Returns: true, if the packet should be retransmitted, false otherwise.

Definition at line 791 of file lr-wpan-mac.cc.

References ns3::IEEE_802_15_4_NO_ACK, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_csmaCa, m_macMaxFrameRetries, m_macTxDropTrace, m_mcpsDataConfirmCallback, ns3::McpsDataConfirmParams::m_msduHandle, m_numCsmacaRetry, m_retransmission, ns3::McpsDataConfirmParams::m_status, m_txQueue, NS_LOG_FUNCTION, RemoveFirstTxQElement(), ns3::LrWpanMac::TxQueueElement::txQMsduHandle, and ns3::LrWpanMac::TxQueueElement::txQPkt.

Referenced by AckWaitTimeout(), and PdDataIndication().

◆ RemoveFirstTxQElement()

void ns3::LrWpanMac::RemoveFirstTxQElement ( )

private

Remove the tip of the transmission queue, including clean up related to the last packet transmission.

Definition at line 749 of file lr-wpan-mac.cc.

References ns3::Packet::Copy(), ns3::LrWpanMacHeader::GetShortDstAddr(), m_csmaCa, m_macTxDequeueTrace, m_numCsmacaRetry, m_retransmission, m_sentPktTrace, m_txPkt, m_txQueue, ns3::Packet::RemoveHeader(), and ns3::LrWpanMac::TxQueueElement::txQPkt.

Referenced by PdDataConfirm(), PdDataIndication(), PrepareRetransmission(), and SetLrWpanMacState().

◆ SendAck()

void ns3::LrWpanMac::SendAck ( uint8_t seqno )

private

Send an acknowledgment packet for the given sequence number.

Parameters

seqno the sequence number for the ACK

Definition at line 720 of file lr-wpan-mac.cc.

References ns3::Packet::AddHeader(), ns3::Packet::AddTrailer(), ChangeMacState(), ns3::Node::ChecksumEnabled(), ns3::LrWpanMacTrailer::EnableFcs(), ns3::IEEE_802_15_4_PHY_TX_ON, ns3::LrWpanMacHeader::LRWPAN_MAC_ACKNOWLEDGMENT, m_lrWpanMacState, m_phy, m_txPkt, ns3::MAC_IDLE, ns3::MAC_SENDING, NS_ASSERT, NS_LOG_FUNCTION, and ns3::LrWpanMacTrailer::SetFcs().

Referenced by PdDataIndication().

◆ SetAssociationStatus()

void ns3::LrWpanMac::SetAssociationStatus ( LrWpanAssociationStatus status )

Set the current association status.

Parameters

status new association status

Definition at line 1036 of file lr-wpan-mac.cc.

References m_associationStatus.

◆ SetCsmaCa()

void ns3::LrWpanMac::SetCsmaCa ( Ptr< LrWpanCsmaCa > csmaCa )

Set the CSMA/CA implementation to be used by the MAC.

Parameters

csmaCa the CSMA/CA implementation

Definition at line 461 of file lr-wpan-mac.cc.

References m_csmaCa.

◆ SetExtendedAddress()

void ns3::LrWpanMac::SetExtendedAddress ( Mac64Address address )

Set the extended address of this MAC.

Parameters

address the new address

Definition at line 229 of file lr-wpan-mac.cc.

References first::address, and m_selfExt.

◆ SetLrWpanMacState()

void ns3::LrWpanMac::SetLrWpanMacState ( LrWpanMacState macState )

CSMA-CA algorithm calls back the MAC after executing channel assessment.

Parameters

macState indicate BUSY or IDLE channel condition

Definition at line 970 of file lr-wpan-mac.cc.

References ChangeMacState(), ns3::CHANNEL_ACCESS_FAILURE, ns3::CHANNEL_IDLE, CheckQueue(), ns3::IEEE_802_15_4_CHANNEL_ACCESS_FAILURE, ns3::IEEE_802_15_4_PHY_RX_ON, ns3::IEEE_802_15_4_PHY_TRX_OFF, ns3::IEEE_802_15_4_PHY_TX_ON, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_lrWpanMacState, m_macRxOnWhenIdle, m_macTxDropTrace, m_mcpsDataConfirmCallback, ns3::McpsDataConfirmParams::m_msduHandle, m_phy, ns3::McpsDataConfirmParams::m_status, m_txPkt, m_txQueue, ns3::MAC_ACK_PENDING, ns3::MAC_CSMA, ns3::MAC_IDLE, ns3::MAC_SENDING, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and RemoveFirstTxQElement().

Referenced by AckWaitTimeout(), CheckQueue(), ns3::LrWpanNetDevice::CompleteConfig(), PdDataConfirm(), and PdDataIndication().

◆ SetMacMaxFrameRetries()

void ns3::LrWpanMac::SetMacMaxFrameRetries ( uint8_t retries )

Set the macMaxFrameRetries attribute value.

Parameters

retries the maximum number of retries

Definition at line 1077 of file lr-wpan-mac.cc.

References m_macMaxFrameRetries.

◆ SetMcpsDataConfirmCallback()

void ns3::LrWpanMac::SetMcpsDataConfirmCallback ( McpsDataConfirmCallback c )

Set the callback for the confirmation of a data transmission request.

The callback implements MCPS-DATA.confirm SAP of IEEE 802.15.4-2006, section 7.1.1.2.

Parameters

c	the callback

Definition at line 485 of file lr-wpan-mac.cc.

References m_mcpsDataConfirmCallback.

◆ SetMcpsDataIndicationCallback()

void ns3::LrWpanMac::SetMcpsDataIndicationCallback ( McpsDataIndicationCallback c )

Set the callback for the indication of an incoming data packet.

The callback implements MCPS-DATA.indication SAP of IEEE 802.15.4-2006, section 7.1.1.3.

Parameters

c	the callback

Definition at line 479 of file lr-wpan-mac.cc.

References m_mcpsDataIndicationCallback.

◆ SetPanId()

void ns3::LrWpanMac::SetPanId ( uint16_t panId )

Set the PAN id used by this MAC.

Parameters

panId the new PAN id.

Definition at line 1048 of file lr-wpan-mac.cc.

References m_macPanId.

◆ SetPhy()

void ns3::LrWpanMac::SetPhy ( Ptr< LrWpanPhy > phy )

Set the underlying PHY for the MAC.

Parameters

phy the PHY

Definition at line 467 of file lr-wpan-mac.cc.

References m_phy, and third::phy.

◆ SetRxOnWhenIdle()

void ns3::LrWpanMac::SetRxOnWhenIdle ( bool rxOnWhenIdle )

Set if the receiver should be enabled when the MAC is idle.

Parameters

rxOnWhenIdle set to true to enable the receiver during idle periods

Definition at line 203 of file lr-wpan-mac.cc.

References ns3::IEEE_802_15_4_PHY_RX_ON, ns3::IEEE_802_15_4_PHY_TRX_OFF, m_lrWpanMacState, m_macRxOnWhenIdle, m_phy, ns3::MAC_IDLE, and NS_LOG_FUNCTION.

◆ SetShortAddress()

void ns3::LrWpanMac::SetShortAddress ( Mac16Address address )

Set the short address of this MAC.

Parameters

address the new address

Definition at line 222 of file lr-wpan-mac.cc.

References first::address, and m_shortAddress.

Member Data Documentation

◆ aMinMPDUOverhead

const uint32_t ns3::LrWpanMac::aMinMPDUOverhead = 9

static

The minimum number of octets added by the MAC sublayer to the PSDU.

See IEEE 802.15.4-2006, section 7.4.1, Table 85

Definition at line 236 of file lr-wpan-mac.h.

Referenced by McpsDataRequest().

◆ m_aBaseSlotDuration

uint64_t ns3::LrWpanMac::m_aBaseSlotDuration

Length of a superframe slot in symbols.

Defaults to 60 symbols in each superframe slot. See IEEE 802.15.4-2006, section 7.4.1, Table 85.

Definition at line 441 of file lr-wpan-mac.h.

◆ m_aBaseSuperframeDuration

uint64_t ns3::LrWpanMac::m_aBaseSuperframeDuration

Length of a superframe in symbols.

Defaults to aBaseSlotDuration * aNumSuperframeSlots in symbols. See IEEE 802.15.4-2006, section 7.4.1, Table 85.

Definition at line 454 of file lr-wpan-mac.h.

◆ m_ackWaitTimeout

EventId ns3::LrWpanMac::m_ackWaitTimeout

private

Scheduler event for the ACK timeout of the currently transmitted data packet.

Definition at line 817 of file lr-wpan-mac.h.

Referenced by PdDataConfirm(), and PdDataIndication().

◆ m_aNumSuperframeSlots

uint64_t ns3::LrWpanMac::m_aNumSuperframeSlots

Number of a superframe slots per superframe.

Defaults to 16. See IEEE 802.15.4-2006, section 7.4.1, Table 85.

Definition at line 447 of file lr-wpan-mac.h.

◆ m_associationStatus

LrWpanAssociationStatus ns3::LrWpanMac::m_associationStatus

private

The current association status of the MAC layer.

Definition at line 777 of file lr-wpan-mac.h.

Referenced by GetAssociationStatus(), LrWpanMac(), and SetAssociationStatus().

◆ m_csmaCa

Ptr<LrWpanCsmaCa> ns3::LrWpanMac::m_csmaCa

private

The CSMA/CA implementation used by this MAC.

Definition at line 754 of file lr-wpan-mac.h.

Referenced by DoDispose(), GetMacAckWaitDuration(), McpsDataRequest(), PdDataIndication(), PlmeCcaConfirm(), PlmeSetTRXStateConfirm(), PrepareRetransmission(), RemoveFirstTxQElement(), and SetCsmaCa().

◆ m_lrWpanMacState

TracedValue<LrWpanMacState> ns3::LrWpanMac::m_lrWpanMacState

private

The current state of the MAC layer.

Definition at line 772 of file lr-wpan-mac.h.

Referenced by ChangeMacState(), CheckQueue(), GetTypeId(), LrWpanMac(), PdDataConfirm(), PdDataIndication(), PlmeSetTRXStateConfirm(), SendAck(), SetLrWpanMacState(), and SetRxOnWhenIdle().

◆ m_macBeaconOrder

uint64_t ns3::LrWpanMac::m_macBeaconOrder

Specification of how often the coordinator transmits its beacon.

0 - 15 with 15 means no beacons are being sent. See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 475 of file lr-wpan-mac.h.

◆ m_macBeaconTxTime

uint64_t ns3::LrWpanMac::m_macBeaconTxTime

The time that the device transmitted its last beacon frame, in symbol periods.

Only 24 bits used. See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 462 of file lr-wpan-mac.h.

◆ m_macDsn

SequenceNumber8 ns3::LrWpanMac::m_macDsn

Sequence number added to transmitted data or MAC command frame, 00-ff.

See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 503 of file lr-wpan-mac.h.

Referenced by LrWpanMac(), and McpsDataRequest().

◆ m_macMaxFrameRetries

uint8_t ns3::LrWpanMac::m_macMaxFrameRetries

The maximum number of retries allowed after a transmission failure.

See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 509 of file lr-wpan-mac.h.

Referenced by GetMacMaxFrameRetries(), LrWpanMac(), PrepareRetransmission(), and SetMacMaxFrameRetries().

◆ m_macPanId

uint16_t ns3::LrWpanMac::m_macPanId

16 bits id of PAN on which this device is operating.

0xffff means not asscoiated. See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 497 of file lr-wpan-mac.h.

Referenced by GetPanId(), GetTypeId(), LrWpanMac(), PdDataIndication(), and SetPanId().

◆ m_macPromiscRxTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macPromiscRxTrace

private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).

This is a promiscuous trace.

See also: class CallBackTraceSource

Definition at line 676 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and PdDataIndication().

◆ m_macPromiscuousMode

bool ns3::LrWpanMac::m_macPromiscuousMode

Indicates if MAC sublayer is in receive all mode.

True mean accept all frames from PHY. See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 490 of file lr-wpan-mac.h.

Referenced by LrWpanMac(), and PdDataIndication().

◆ m_macRxDropTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macRxDropTrace

private

The trace source fired for packets successfully received by the device but dropped before being forwarded up to higher layers (at the L2/L3 transition).

See also: class CallBackTraceSource

Definition at line 694 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and PdDataIndication().

◆ m_macRxOnWhenIdle

bool ns3::LrWpanMac::m_macRxOnWhenIdle

Indication of whether the MAC sublayer is to enable its receiver during idle periods.

See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 516 of file lr-wpan-mac.h.

Referenced by DoInitialize(), GetRxOnWhenIdle(), LrWpanMac(), SetLrWpanMacState(), and SetRxOnWhenIdle().

◆ m_macRxTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macRxTrace

private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).

This is a non-promiscuous trace.

See also: class CallBackTraceSource

Definition at line 685 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and PdDataIndication().

◆ m_macStateLogger

TracedCallback<LrWpanMacState, LrWpanMacState> ns3::LrWpanMac::m_macStateLogger

private

A trace source that fires when the LrWpanMac changes states.

Parameters are the old mac state and the new mac state.

Deprecated:: This TracedCallback is deprecated and will be removed in a future release, Instead, use the MacStateValue TracedValue.

Definition at line 744 of file lr-wpan-mac.h.

Referenced by ChangeMacState(), and GetTypeId().

◆ m_macSuperframeOrder

uint64_t ns3::LrWpanMac::m_macSuperframeOrder

The length of the active portion of the outgoing superframe, including the beacon frame.

0 - 15 with 15 means the superframe will not be active after the beacon. See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 483 of file lr-wpan-mac.h.

◆ m_macSyncSymbolOffset

uint64_t ns3::LrWpanMac::m_macSyncSymbolOffset

Symbol boundary is same as m_macBeaconTxTime.

See IEEE 802.15.4-2006, section 7.4.2, Table 86.

Definition at line 468 of file lr-wpan-mac.h.

◆ m_macTxDequeueTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macTxDequeueTrace

private

The trace source fired when packets are dequeued from the L3/l2 transmission queue.

See also: class CallBackTraceSource

Definition at line 643 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and RemoveFirstTxQElement().

◆ m_macTxDropTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macTxDropTrace

private

The trace source fired when packets are dropped due to missing ACKs or because of transmission failures in L1.

See also: class CallBackTraceSource

Definition at line 667 of file lr-wpan-mac.h.

Referenced by GetTypeId(), PdDataConfirm(), PrepareRetransmission(), and SetLrWpanMacState().

◆ m_macTxEnqueueTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macTxEnqueueTrace

private

The trace source fired when packets come into the "top" of the device at the L3/L2 transition, when being queued for transmission.

See also: class CallBackTraceSource

Definition at line 635 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and McpsDataRequest().

◆ m_macTxOkTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macTxOkTrace

private

The trace source fired when packets where successfully transmitted, that is an acknowledgment was received, if requested, or the packet was successfully sent by L1, if no ACK was requested.

See also: class CallBackTraceSource

Definition at line 659 of file lr-wpan-mac.h.

Referenced by GetTypeId(), PdDataConfirm(), and PdDataIndication().

◆ m_macTxTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_macTxTrace

private

The trace source fired when packets are being sent down to L1.

See also: class CallBackTraceSource

Definition at line 650 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and PlmeSetTRXStateConfirm().

◆ m_mcpsDataConfirmCallback

McpsDataConfirmCallback ns3::LrWpanMac::m_mcpsDataConfirmCallback

private

This callback is used to report data transmission request status to the upper layers.

See IEEE 802.15.4-2006, section 7.1.1.2.

Definition at line 767 of file lr-wpan-mac.h.

Referenced by DoDispose(), McpsDataRequest(), PdDataConfirm(), PdDataIndication(), PrepareRetransmission(), SetLrWpanMacState(), and SetMcpsDataConfirmCallback().

◆ m_mcpsDataIndicationCallback

McpsDataIndicationCallback ns3::LrWpanMac::m_mcpsDataIndicationCallback

private

This callback is used to notify incoming packets to the upper layers.

See IEEE 802.15.4-2006, section 7.1.1.3.

Definition at line 760 of file lr-wpan-mac.h.

Referenced by DoDispose(), PdDataIndication(), and SetMcpsDataIndicationCallback().

◆ m_numCsmacaRetry

uint8_t ns3::LrWpanMac::m_numCsmacaRetry

private

The number of CSMA/CA retries used for sending the current packet.

Definition at line 811 of file lr-wpan-mac.h.

Referenced by LrWpanMac(), PrepareRetransmission(), and RemoveFirstTxQElement().

◆ m_phy

Ptr<LrWpanPhy> ns3::LrWpanMac::m_phy

private

The PHY associated with this MAC.

Definition at line 749 of file lr-wpan-mac.h.

Referenced by DoDispose(), DoInitialize(), GetMacAckWaitDuration(), GetPhy(), PdDataConfirm(), PlmeSetTRXStateConfirm(), SendAck(), SetLrWpanMacState(), SetPhy(), and SetRxOnWhenIdle().

◆ m_promiscSnifferTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_promiscSnifferTrace

private

A trace source that emulates a promiscuous mode protocol sniffer connected to the device.

This trace source fire on packets destined for any host just like your average everyday packet sniffer.

On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit where dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.

On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb.

See also: class CallBackTraceSource

Definition at line 734 of file lr-wpan-mac.h.

Referenced by GetTypeId(), PdDataIndication(), and PlmeSetTRXStateConfirm().

◆ m_retransmission

uint8_t ns3::LrWpanMac::m_retransmission

private

The number of already used retransmission for the currently transmitted packet.

Definition at line 806 of file lr-wpan-mac.h.

Referenced by LrWpanMac(), PrepareRetransmission(), and RemoveFirstTxQElement().

◆ m_selfExt

Mac64Address ns3::LrWpanMac::m_selfExt

private

The extended address used by this MAC.

Extended addresses are currently not really supported.

Definition at line 795 of file lr-wpan-mac.h.

Referenced by GetExtendedAddress(), LrWpanMac(), PdDataIndication(), and SetExtendedAddress().

◆ m_sentPktTrace

TracedCallback<Ptr<const Packet>, uint8_t, uint8_t > ns3::LrWpanMac::m_sentPktTrace

private

The trace source fired when packets are considered as successfully sent or the transmission has been given up.

Only non-broadcast packets are traced.

The data should represent: packet, number of retries, total number of csma backoffs

See also: class CallBackTraceSource

Definition at line 627 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and RemoveFirstTxQElement().

◆ m_setMacState

EventId ns3::LrWpanMac::m_setMacState

private

Scheduler event for a deferred MAC state change.

Definition at line 822 of file lr-wpan-mac.h.

Referenced by CheckQueue(), PdDataConfirm(), and PdDataIndication().

◆ m_shortAddress

Mac16Address ns3::LrWpanMac::m_shortAddress

private

The short address used by this MAC.

Currently we do not have complete extended address support in the MAC, nor do we have the association primitives, so this address has to be configured manually.

Definition at line 789 of file lr-wpan-mac.h.

Referenced by GetShortAddress(), LrWpanMac(), PdDataIndication(), and SetShortAddress().

◆ m_snifferTrace

TracedCallback<Ptr<const Packet> > ns3::LrWpanMac::m_snifferTrace

private

A trace source that emulates a non-promiscuous protocol sniffer connected to the device.

Unlike your average everyday sniffer, this trace source will not fire on PACKET_OTHERHOST events.

On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit where dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.

On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb.

See also: class CallBackTraceSource

Definition at line 714 of file lr-wpan-mac.h.

Referenced by GetTypeId(), and PlmeSetTRXStateConfirm().

◆ m_txPkt

Ptr<Packet> ns3::LrWpanMac::m_txPkt

private

The packet which is currently being sent by the MAC layer.

Definition at line 782 of file lr-wpan-mac.h.

Referenced by CheckQueue(), DoDispose(), LrWpanMac(), PdDataConfirm(), PdDataIndication(), PlmeSetTRXStateConfirm(), RemoveFirstTxQElement(), SendAck(), and SetLrWpanMacState().

◆ m_txQueue

std::deque<TxQueueElement*> ns3::LrWpanMac::m_txQueue

private

The transmit queue used by the MAC.

Definition at line 800 of file lr-wpan-mac.h.

Referenced by CheckQueue(), DoDispose(), McpsDataRequest(), PdDataConfirm(), PdDataIndication(), PrepareRetransmission(), RemoveFirstTxQElement(), and SetLrWpanMacState().

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

src/lr-wpan/model/lr-wpan-mac.h
src/lr-wpan/model/lr-wpan-mac.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Typedef Documentation

◆ SentTracedCallback

◆ StateTracedCallback

Constructor & Destructor Documentation

◆ LrWpanMac()

◆ ~LrWpanMac()

Member Function Documentation

◆ AckWaitTimeout()

◆ ChangeMacState()

◆ CheckQueue()

◆ DoDispose()

◆ DoInitialize()

◆ GetAssociationStatus()

◆ GetExtendedAddress()

◆ GetMacAckWaitDuration()

◆ GetMacMaxFrameRetries()

◆ GetPanId()

◆ GetPhy()

◆ GetRxOnWhenIdle()

◆ GetShortAddress()

◆ GetTypeId()

◆ McpsDataRequest()

◆ PdDataConfirm()

◆ PdDataIndication()

◆ PlmeCcaConfirm()

◆ PlmeEdConfirm()

◆ PlmeGetAttributeConfirm()

◆ PlmeSetAttributeConfirm()

◆ PlmeSetTRXStateConfirm()

◆ PrepareRetransmission()

◆ RemoveFirstTxQElement()

◆ SendAck()

◆ SetAssociationStatus()

◆ SetCsmaCa()

◆ SetExtendedAddress()

◆ SetLrWpanMacState()

◆ SetMacMaxFrameRetries()

◆ SetMcpsDataConfirmCallback()

◆ SetMcpsDataIndicationCallback()

◆ SetPanId()

◆ SetPhy()

◆ SetRxOnWhenIdle()

◆ SetShortAddress()

Member Data Documentation

◆ aMinMPDUOverhead

◆ m_aBaseSlotDuration

◆ m_aBaseSuperframeDuration

◆ m_ackWaitTimeout

◆ m_aNumSuperframeSlots

◆ m_associationStatus

◆ m_csmaCa

◆ m_lrWpanMacState

◆ m_macBeaconOrder

◆ m_macBeaconTxTime

◆ m_macDsn

◆ m_macMaxFrameRetries

◆ m_macPanId

◆ m_macPromiscRxTrace

◆ m_macPromiscuousMode

◆ m_macRxDropTrace

◆ m_macRxOnWhenIdle

◆ m_macRxTrace

◆ m_macStateLogger

◆ m_macSuperframeOrder

◆ m_macSyncSymbolOffset

◆ m_macTxDequeueTrace