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

#include "lr-wpan-mac.h"

Inheritance diagram for ns3::LrWpanMac:

Collaboration diagram for ns3::LrWpanMac:

Classes
struct	IndTxQueueElement
	Helper structure for managing pending transaction list elements (Indirect transmissions). More...

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.

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

Public Member Functions
	LrWpanMac ()
	Default constructor.

	~LrWpanMac () override

LrWpanAssociationStatus	GetAssociationStatus () const
	Get the current association status.

Mac64Address	GetCoordExtAddress () const
	Get the coordinator extended address currently associated to this device.

Mac16Address	GetCoordShortAddress () const
	Get the coordinator short address currently associated to this device.

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

uint32_t	GetIfsSize ()
	Get the size of the Interframe Space according to MPDU size (m_txPkt).

uint64_t	GetMacAckWaitDuration () const
	Get the macAckWaitDuration attribute value.

uint8_t	GetMacMaxFrameRetries () const
	Get the macMaxFrameRetries attribute value.

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

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

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

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

uint64_t	GetTxPacketSymbols ()
	Obtain the number of symbols in the packet which is currently being sent by the MAC layer.

bool	isCoordDest ()
	Check if the packet destination is its coordinator.

bool	isTxAckReq ()
	Check if the packet to transmit requires acknowledgment.

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.

void	MlmeAssociateRequest (MlmeAssociateRequestParams params)
	IEEE 802.15.4-2011, section 6.2.2.1 MLME-ASSOCIATE.request Request primitive used by a device to request an association with a coordinator.

void	MlmeAssociateResponse (MlmeAssociateResponseParams params)
	IEEE 802.15.4-2011, section 6.2.2.3 MLME-ASSOCIATE.response Primitive used to initiate a response to an MLME-ASSOCIATE.indication primitive.

void	MlmeGetRequest (LrWpanMacPibAttributeIdentifier id)
	IEEE 802.15.4-2011, section 6.2.5.1 MLME-GET.request Request information about a given PIB attribute.

void	MlmeOrphanResponse (MlmeOrphanResponseParams params)
	IEEE 802.15.4-2011, section 6.2.7.2 MLME-ORPHAN.response Primitive used to initiatte a response to an MLME-ORPHAN.indication primitive.

void	MlmePollRequest (MlmePollRequestParams params)
	IEEE 802.15.4-2011, section 6.2.14.2 MLME-POLL.request Prompts the device to request data from the coordinator.

void	MlmeScanRequest (MlmeScanRequestParams params)
	IEEE 802.15.4-2011, section 6.2.10.1 MLME-SCAN.request Request primitive used to initiate a channel scan over a given list of channels.

void	MlmeSetRequest (LrWpanMacPibAttributeIdentifier id, Ptr< LrWpanMacPibAttributes > attribute)
	IEEE 802.15.4-2011, section 6.2.11.1 MLME-SET.request Attempts to write the given value to the indicated PIB attribute.

void	MlmeStartRequest (MlmeStartRequestParams params)
	IEEE 802.15.4-2006, section 7.1.14.1 MLME-START.request Request to allow a PAN coordinator to initiate a new PAN or beginning a new superframe configuration.

void	MlmeSyncRequest (MlmeSyncRequestParams params)
	IEEE 802.15.4-2011, section 6.2.13.1 MLME-SYNC.request Request to synchronize with the coordinator by acquiring and, if specified, tracking beacons.

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

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)

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

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

void	PlmeGetAttributeConfirm (LrWpanPhyEnumeration status, LrWpanPibAttributeIdentifier id, Ptr< 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.

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.

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

void	PrintPendTxQ (std::ostream &os) const
	Print the Pending transaction list.

void	PrintTransmitQueueSize ()
	Print the number of elements in the packet transmit queue.

void	PrintTxQueue (std::ostream &os) const
	Print the Transmit Queue.

void	SetAssociatedCoor (Mac16Address mac)
	Check if the packet destination is its coordinator.

void	SetAssociatedCoor (Mac64Address mac)
	Check if the packet destination is its coordinator.

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

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

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

void	SetIndTxQMaxSize (uint32_t queueSize)
	Set the max size of the indirect transmit queue (Pending Transaction list)

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

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

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

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

void	SetMlmeAssociateConfirmCallback (MlmeAssociateConfirmCallback c)
	Set the callback for the confirmation of a data transmission request.

void	SetMlmeAssociateIndicationCallback (MlmeAssociateIndicationCallback c)
	Set the callback for the indication of an incoming associate request command.

void	SetMlmeBeaconNotifyIndicationCallback (MlmeBeaconNotifyIndicationCallback c)
	Set the callback for the indication of an incoming beacon packet.

void	SetMlmeCommStatusIndicationCallback (MlmeCommStatusIndicationCallback c)
	Set the callback for the indication to a response primitive.

void	SetMlmeGetConfirmCallback (MlmeGetConfirmCallback c)
	Set the callback for the confirmation of an attempt to read an attribute.

void	SetMlmeOrphanIndicationCallback (MlmeOrphanIndicationCallback c)
	Set the callback for the indication to the reception of an orphan notification.

void	SetMlmePollConfirmCallback (MlmePollConfirmCallback c)
	Set the callback for the confirmation of a data transmission request.

void	SetMlmeScanConfirmCallback (MlmeScanConfirmCallback c)
	Set the callback for the confirmation of a data transmission request.

void	SetMlmeSetConfirmCallback (MlmeSetConfirmCallback c)
	Set the callback for the confirmation of an attempt to write an attribute.

void	SetMlmeStartConfirmCallback (MlmeStartConfirmCallback c)
	Set the callback for the confirmation of a data transmission request.

void	SetMlmeSyncLossIndicationCallback (MlmeSyncLossIndicationCallback c)
	Set the callback for the loss of synchronization with a coordinator.

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

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

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

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

void	SetTxQMaxSize (uint32_t queueSize)
	Set the max size of the transmit queue.

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

	~Object () override
	Destructor.

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

void	Dispose ()
	Dispose of this Object.

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

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

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

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

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

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

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

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

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

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

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

Public Attributes
uint64_t	m_assocRespCmdWaitTime
	The maximum wait time for an association response command after the reception of data request command ACK during the association process.

uint32_t	m_beaconInterval
	Indication of the Interval used by the coordinator to transmit beacon frames expressed in symbols.

bool	m_beaconTrackingOn
	Indication of whether the current device is tracking incoming beacons.

bool	m_coor
	Indicates if the current device is a coordinator type.

uint8_t	m_deviceCapability
	Indication of current device capability (FFD or RFD)

uint8_t	m_fnlCapSlot
	Indication of the Slot where the CAP portion of the OUTGOING Superframe ends.

uint32_t	m_ifs
	The value of the necessary InterFrame Space after the transmission of a packet.

uint32_t	m_incomingBeaconInterval
	Indication of the interval a node should receive a superframe expressed in symbols.

uint8_t	m_incomingBeaconOrder
	The beaconOrder value of the INCOMING frame.

uint8_t	m_incomingFnlCapSlot
	Indication of the Slot where the CAP portion of the INCOMING Superframe ends.

uint32_t	m_incomingSuperframeDuration
	Indication of the superframe duration in symbols (e.g.

uint8_t	m_incomingSuperframeOrder
	Used by all devices that have a parent.

bool	m_macAssociationPermit
	Indication of whether a coordinator is currently allowing association.

bool	m_macAutoRequest
	Indication of whether a device automatically sends data request command if its address is listed in the beacon frame.

uint8_t	m_macBeaconOrder
	Used by a PAN coordinator or coordinator.

Ptr< Packet >	m_macBeaconPayload
	The contents of the beacon payload.

uint32_t	m_macBeaconPayloadLength
	The length, in octets, of the beacon payload.

Time	m_macBeaconRxTime
	The time that the device received its last bit of the beacon frame.

Time	m_macBeaconTxTime
	The time that the device transmitted its last beacon frame.

SequenceNumber8	m_macBsn
	Sequence number added to transmitted beacon frame, 00-ff.

Mac64Address	m_macCoordExtendedAddress
	The extended address of the coordinator through which the device is associated.

Mac16Address	m_macCoordShortAddress
	The short address of the coordinator through which the device is associated.

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

uint32_t	m_macLIFSPeriod
	The minimum time forming a Long InterFrame Spacing (LIFS) period.

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

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

uint16_t	m_macPanIdScan
	Temporally stores the value of the current m_macPanId when a MLME-SCAN.request is performed.

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

uint64_t	m_macResponseWaitTime
	The maximum time, in multiples of aBaseSuperframeDuration, a device shall wait for a response command frame to be available following a request command frame.

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

uint32_t	m_macSIFSPeriod
	The minimum time forming a Short InterFrame Spacing (SIFS) period.

uint8_t	m_macSuperframeOrder
	Used by a PAN coordinator or coordinator.

uint64_t	m_macSyncSymbolOffset
	Symbol boundary is same as m_macBeaconTxTime.

uint16_t	m_macTransactionPersistenceTime
	The maximum time (in UNIT periods) that a transaction is stored by a coordinator and indicated in its beacon.

uint8_t	m_maxEnergyLevel
	The maximum energy level detected during ED scan on the current channel.

uint8_t	m_numLostBeacons
	The number of consecutive loss beacons in a beacon tracking operation.

bool	m_panCoor
	Indication of whether the current device is the PAN coordinator.

uint64_t	m_rxBeaconSymbols
	The total size of the received beacon in symbols.

uint32_t	m_superframeDuration
	Indication of the superframe duration in symbols.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

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

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

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

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

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

void	AwaitBeacon ()
	Called after the end of an INCOMING superframe to start the moment a device waits for a new incoming beacon.

void	BeaconSearchTimeout ()
	Called if the device is unable to locate a beacon in the time set by MLME-SYNC.request.

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

void	CheckQueue ()
	Check the transmission queue.

bool	DequeueInd (Mac64Address dst, Ptr< IndTxQueueElement > entry)
	Extracts a packet from pending transactions list (Indirect transmissions).

void	EndAssociateRequest ()
	Called to end an MLME-ASSOCIATE.request after changing the page and channel number.

void	EndChannelEnergyScan ()
	Called at the end of one ED channel scan.

void	EndChannelScan ()
	Called at the end of the current channel scan (Active or Passive) for a given duration.

void	EndStartRequest ()
	Called to end a MLME-START.request after changing the page and channel number.

void	EnqueueInd (Ptr< Packet > p)
	Adds a packet to the pending transactions list (Indirect transmissions).

void	EnqueueTxQElement (Ptr< TxQueueElement > txQElement)
	Add an element to the transmission queue.

GtsFields	GetGtsFields ()
	Constructs the Guaranteed Time Slots (GTS) Fields from local information.

PendingAddrFields	GetPendingAddrFields ()
	Constructs Pending Address Fields from the local information, the Pending Address Fields are part of the beacon frame.

SuperframeField	GetSuperframeField ()
	Constructs a Superframe specification field from the local information, the superframe Specification field is necessary to create a beacon frame.

void	IfsWaitTimeout (Time ifsTime)
	After a successful transmission of a frame (beacon, data) or an ack frame reception, the mac layer wait an Interframe Space (IFS) time and triggers this function to continue with the MAC flow.

void	LostAssocRespCommand ()
	Called after m_assocRespCmdWaitTime timeout while waiting for an association response command.

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

void	PurgeInd ()
	Purge expired transactions from the pending transactions list.

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

void	RemovePendTxQElement (Ptr< Packet > p)
	Remove an element from the pending transaction list.

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

void	SendAssocRequestCommand ()
	Called to send an associate request command.

void	SendAssocResponseCommand (Ptr< Packet > rxDataReqPkt)
	Called to send an associate response command.

void	SendBeaconRequestCommand ()
	Called to send a beacon request command.

void	SendDataRequestCommand ()
	Used to send a data request command (i.e.

void	SendOneBeacon ()
	Called to send a single beacon frame.

void	SendOrphanNotificationCommand ()
	Called to send a orphan notification command.

void	StartCAP (SuperframeType superframeType)
	Called to begin the Contention Access Period (CAP) in a beacon-enabled mode.

void	StartCFP (SuperframeType superframeType)
	Called to begin the Contention Free Period (CFP) in a beacon-enabled mode.

void	StartInactivePeriod (SuperframeType superframeType)
	Start the Inactive Period in a beacon-enabled mode.

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

MlmeAssociateRequestParams	m_associateParams
	The parameters used during a MLME-ASSOCIATE.request.

LrWpanAssociationStatus	m_associationStatus
	The current association status of the MAC layer.

EventId	m_assocResCmdWaitTimeout
	Scheduler event for the lost of a association response command frame.

EventId	m_beaconEvent
	Scheduler event for generation of one beacon.

EventId	m_capEvent
	Scheduler event for the end of the outgoing superframe CAP.

EventId	m_cfpEvent
	Scheduler event for the end of the outgoing superframe CFP.

uint16_t	m_channelScanIndex
	The channel list index used to obtain the current scanned channel.

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

std::vector< uint8_t >	m_energyDetectList
	The list of energy measurements, one for each channel searched during an ED scan.

EventId	m_ifsEvent
	Scheduler event for Interframe spacing wait time.

EventId	m_incCapEvent
	Scheduler event for the end of the incoming superframe CAP.

EventId	m_incCfpEvent
	Scheduler event for the end of the incoming superframe CFP.

TracedValue< SuperframeStatus >	m_incSuperframeStatus
	The current period of the incoming superframe.

std::deque< Ptr< IndTxQueueElement > >	m_indTxQueue
	The indirect transmit queue used by the MAC pending messages (The pending transaction list).

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

TracedCallback< Time >	m_macIfsEndTrace
	The trace source is fired at the end of any Interframe Space (IFS).

TracedCallback< Ptr< const Packet > >	m_macIndTxDequeueTrace
	The trace source fired when packets are dequeued from the L3/l2 indirect transmission queue (Pending transaction list).

TracedCallback< Ptr< const Packet > >	m_macIndTxDropTrace
	The trace source fired when packets are dropped due to indirect Tx queue overflows or expiration.

TracedCallback< Ptr< const Packet > >	m_macIndTxEnqueueTrace
	The trace source fired when packets come into the "top" of the device at the L3/L2 transition, when being queued for indirect transmission (pending transaction list).

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

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

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

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

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

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.

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.

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.

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

uint32_t	m_maxIndTxQueueSize
	The maximum size of the indirect transmit queue (The pending transaction list).

uint32_t	m_maxTxQueueSize
	The maximum size of the transmit queue.

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

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

MlmeAssociateConfirmCallback	m_mlmeAssociateConfirmCallback
	This callback is used to report the status after a device request an association with a coordinator.

MlmeAssociateIndicationCallback	m_mlmeAssociateIndicationCallback
	This callback is used to indicate the reception of an association request command.

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

MlmeCommStatusIndicationCallback	m_mlmeCommStatusIndicationCallback
	This callback is instigated through a response primitive.

MlmeGetConfirmCallback	m_mlmeGetConfirmCallback
	This callback is used to report the result of an attribute read request to the upper layers.

MlmeOrphanIndicationCallback	m_mlmeOrphanIndicationCallback
	This callback is used to indicate the reception of a orphan notification command.

MlmePollConfirmCallback	m_mlmePollConfirmCallback
	This callback is used to report the status after a device send data command request to the coordinator to transmit data.

MlmeScanConfirmCallback	m_mlmeScanConfirmCallback
	This callback is used to report the result of a scan on a group of channels for the selected channel page.

MlmeSetConfirmCallback	m_mlmeSetConfirmCallback
	This callback is used to report the result of an attribute writing request to the upper layers.

MlmeStartConfirmCallback	m_mlmeStartConfirmCallback
	This callback is used to report the start of a new PAN or the begin of a new superframe configuration.

MlmeSyncLossIndicationCallback	m_mlmeSyncLossIndicationCallback
	This callback is used to indicate the loss of synchronization with a coordinator.

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

TracedValue< SuperframeStatus >	m_outSuperframeStatus
	The current period of the outgoing superframe.

std::vector< PanDescriptor >	m_panDescriptorList
	The list of PAN descriptors accumulated during channel scans, used to select a PAN to associate.

PendingPrimitiveStatus	m_pendPrimitive
	Indicates the pending primitive when PLME.SET operation (page or channel switch) is called from within another MLME primitive (e.g.

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

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

EventId	m_respWaitTimeout
	Scheduler event for a response to a request command frame.

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

Ptr< Packet >	m_rxPkt
	The command request packet received.

EventId	m_scanEnergyEvent
	Scheduler event for the end of a ED channel scan.

EventId	m_scanEvent
	Scheduler event for the end of an ACTIVE or PASSIVE channel scan.

EventId	m_scanOrphanEvent
	Scheduler event for the end of an ORPHAN channel scan.

MlmeScanRequestParams	m_scanParams
	The parameters used during a MLME-SCAN.request.

Mac64Address	m_selfExt
	The extended 64 address (IEEE EUI-64) used by this MAC.

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.

EventId	m_setMacState
	Scheduler event for a deferred MAC state change.

Mac16Address	m_shortAddress
	The short address (16 bit address) used by this MAC.

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

MlmeStartRequestParams	m_startParams
	The parameters used during a MLME-START.request.

EventId	m_trackingEvent
	Scheduler event to track the incoming beacons.

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

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

std::vector< uint8_t >	m_unscannedChannels
	The list of unscanned channels during a scan operation.

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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: constructwriteread

TraceSources

IfsEnd: Trace source reporting the end of an Interframe space (IFS)
Callback signature: ns3::Packet::TracedCallback
MacIncSuperframeStatus: The period status of the incoming superframe
Callback signature: ns3::TracedValueCallback::SuperframeState
MacIndTxDequeue: Trace source indicating a packet has was dequeued from the indirect transaction queue
Callback signature: ns3::Packet::TracedCallback
MacIndTxDrop: Trace source indicating a packet has been dropped from the indirect transaction queue(The pending transaction list)
Callback signature: ns3::Packet::TracedCallback
MacIndTxEnqueue: Trace source indicating a packet has been enqueued in the indirect transaction queue
Callback signature: ns3::Packet::TracedCallback
MacOutSuperframeStatus: The period status of the outgoing superframe
Callback signature: ns3::TracedValueCallback::SuperframeState
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
MacSentPkt: Trace source reporting some information about the sent packet
Callback signature: ns3::LrWpanMac::SentTracedCallback
MacState: The state of LrWpan Mac
Callback signature: ns3::LrWpanMac::StateTracedCallback
MacStateValue: The state of LrWpan Mac
Callback signature: ns3::TracedValueCallback::LrWpanMacState
MacTx: Trace source indicating a packet has arrived for transmission by this device
Callback signature: ns3::Packet::TracedCallback
MacTxDequeue: Trace source indicating a packet has was dequeued from the transaction queue
Callback signature: ns3::Packet::TracedCallback
MacTxDrop: Trace source indicating a packet has been dropped during transmission
Callback signature: ns3::Packet::TracedCallback
MacTxEnqueue: Trace source indicating a packet has been enqueued in the transaction queue
Callback signature: ns3::Packet::TracedCallback
MacTxOk: Trace source indicating a packet has been successfully sent
Callback signature: ns3::Packet::TracedCallback
PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback
Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback

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

Definition at line 837 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 1602 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 1613 of file lr-wpan-mac.h.

Constructor & Destructor Documentation

◆ LrWpanMac()

ns3::LrWpanMac::LrWpanMac ( )

Default constructor.

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

References ns3::lrwpan::aBaseSuperframeDuration, ns3::Mac64Address::Allocate(), ns3::ASSOCIATED, ChangeMacState(), ns3::FFD, ns3::INACTIVE, m_associationStatus, m_assocRespCmdWaitTime, m_beaconTrackingOn, m_channelScanIndex, m_coor, m_deviceCapability, m_ifs, m_incomingBeaconOrder, m_incomingSuperframeOrder, m_incSuperframeStatus, m_indTxQueue, m_lrWpanMacState, m_macAssociationPermit, m_macAutoRequest, m_macBeaconOrder, m_macBeaconPayload, m_macBeaconPayloadLength, m_macBsn, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macDsn, m_macLIFSPeriod, m_macMaxFrameRetries, m_macPanId, m_macPromiscuousMode, m_macResponseWaitTime, m_macRxOnWhenIdle, m_macSIFSPeriod, m_macSuperframeOrder, m_macTransactionPersistenceTime, m_maxEnergyLevel, m_maxIndTxQueueSize, m_maxTxQueueSize, m_numCsmacaRetry, m_numLostBeacons, m_outSuperframeStatus, m_panCoor, m_pendPrimitive, m_retransmission, m_rxPkt, m_selfExt, m_shortAddress, m_txPkt, m_txQueue, ns3::MAC_IDLE, and ns3::MLME_NONE.

Here is the call graph for this function:

◆ ~LrWpanMac()

ns3::LrWpanMac::~LrWpanMac ( )

override

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

Member Function Documentation

◆ AckWaitTimeout()

void ns3::LrWpanMac::AckWaitTimeout ( )

private

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

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

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

Referenced by PdDataConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AwaitBeacon()

void ns3::LrWpanMac::AwaitBeacon ( )

private

Called after the end of an INCOMING superframe to start the moment a device waits for a new incoming beacon.

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

References ns3::BEACON, and m_incSuperframeStatus.

Referenced by StartInactivePeriod().

Here is the caller graph for this function:

◆ BeaconSearchTimeout()

void ns3::LrWpanMac::BeaconSearchTimeout ( )

private

Called if the device is unable to locate a beacon in the time set by MLME-SYNC.request.

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

References ns3::lrwpan::aBaseSuperframeDuration, ns3::lrwpan::aMaxLostBeacons, BeaconSearchTimeout(), m_beaconTrackingOn, m_incomingBeaconOrder, ns3::MlmeSyncLossIndicationParams::m_lossReason, m_macPanId, m_mlmeSyncLossIndicationCallback, m_numLostBeacons, ns3::MlmeSyncLossIndicationParams::m_panId, m_phy, m_trackingEvent, ns3::MLMESYNCLOSS_BEACON_LOST, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by BeaconSearchTimeout(), MlmeSyncRequest(), and PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 3834 of file lr-wpan-mac.cc.

References m_lrWpanMacState, m_macStateLogger, and NS_LOG_LOGIC.

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

Here is the caller graph for this function:

◆ CheckQueue()

void ns3::LrWpanMac::CheckQueue ( )

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 1691 of file lr-wpan-mac.cc.

References ns3::CAP, ns3::EventId::IsRunning(), m_coor, m_csmaCa, m_ifsEvent, m_incSuperframeStatus, m_lrWpanMacState, m_outSuperframeStatus, m_setMacState, m_txPkt, m_txQueue, ns3::MAC_CSMA, ns3::MAC_IDLE, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SetLrWpanMacState().

Referenced by IfsWaitTimeout(), McpsDataRequest(), MlmeOrphanResponse(), PlmeSetTRXStateConfirm(), SendAssocRequestCommand(), SendBeaconRequestCommand(), SendDataRequestCommand(), SendOrphanNotificationCommand(), and StartCAP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DequeueInd()

bool ns3::LrWpanMac::DequeueInd	(	Mac64Address	dst,
		Ptr< IndTxQueueElement >	entry
	)

private

Extracts a packet from pending transactions list (Indirect transmissions).

Parameters

dst	The extended address used an index to obtain an element from the pending transaction list.
entry	The dequeued element from the pending transaction list.

Returns: The status of the dequeue

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

References m_indTxQueue, m_macIndTxDequeueTrace, and PurgeInd().

Referenced by SendAssocResponseCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::LrWpanMac::DoDispose ( )

overrideprotectedvirtual

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 244 of file lr-wpan-mac.cc.

References ns3::EventId::Cancel(), ns3::Object::DoDispose(), m_beaconEvent, m_csmaCa, m_energyDetectList, m_indTxQueue, m_mcpsDataConfirmCallback, m_mcpsDataIndicationCallback, m_mlmeAssociateConfirmCallback, m_mlmeAssociateIndicationCallback, m_mlmeBeaconNotifyIndicationCallback, m_mlmeCommStatusIndicationCallback, m_mlmeOrphanIndicationCallback, m_mlmePollConfirmCallback, m_mlmeScanConfirmCallback, m_mlmeStartConfirmCallback, m_mlmeSyncLossIndicationCallback, m_panDescriptorList, m_phy, m_scanEnergyEvent, m_scanEvent, m_scanOrphanEvent, m_txPkt, m_txQueue, and m_unscannedChannels.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::LrWpanMac::DoInitialize ( )

overrideprotectedvirtual

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

Here is the call graph for this function:

◆ EndAssociateRequest()

void ns3::LrWpanMac::EndAssociateRequest ( )

private

Called to end an MLME-ASSOCIATE.request after changing the page and channel number.

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

References m_associateParams, ns3::MlmeAssociateRequestParams::m_coordAddrMode, ns3::MlmeAssociateRequestParams::m_coordExtAddr, ns3::MlmeAssociateRequestParams::m_coordPanId, ns3::MlmeAssociateRequestParams::m_coordShortAddr, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macPanId, m_pendPrimitive, ns3::MLME_NONE, SendAssocRequestCommand(), and ns3::SHORT_ADDR.

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndChannelEnergyScan()

void ns3::LrWpanMac::EndChannelEnergyScan ( )

private

Called at the end of one ED channel scan.

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

References ns3::Callback< R, UArgs >::IsNull(), m_channelScanIndex, ns3::MlmeScanConfirmParams::m_chPage, m_energyDetectList, ns3::MlmeScanConfirmParams::m_energyDetList, m_macPanId, m_macPanIdScan, m_maxEnergyLevel, m_mlmeScanConfirmCallback, m_pendPrimitive, m_phy, ns3::MlmeScanConfirmParams::m_resultListSize, ns3::MlmeScanRequestParams::m_scanChannels, m_scanParams, ns3::MlmeScanRequestParams::m_scanType, ns3::MlmeScanConfirmParams::m_scanType, ns3::MlmeScanConfirmParams::m_status, ns3::MLME_NONE, ns3::MLMESCAN_SUCCESS, NS_LOG_FUNCTION, and ns3::phyCurrentChannel.

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndChannelScan()

void ns3::LrWpanMac::EndChannelScan ( )

private

Called at the end of the current channel scan (Active or Passive) for a given duration.

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

References ns3::Callback< R, UArgs >::IsNull(), m_channelScanIndex, ns3::MlmeScanRequestParams::m_chPage, ns3::MlmeScanConfirmParams::m_chPage, ns3::MlmeScanConfirmParams::m_energyDetList, m_macAutoRequest, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macPanId, m_macPanIdScan, m_mlmeScanConfirmCallback, ns3::MlmeScanConfirmParams::m_panDescList, m_panDescriptorList, m_pendPrimitive, m_phy, ns3::MlmeScanConfirmParams::m_resultListSize, ns3::MlmeScanRequestParams::m_scanChannels, m_scanParams, ns3::MlmeScanRequestParams::m_scanType, ns3::MlmeScanConfirmParams::m_scanType, m_shortAddress, ns3::MlmeScanConfirmParams::m_status, ns3::MlmeScanConfirmParams::m_unscannedCh, m_unscannedChannels, ns3::MLME_NONE, ns3::MLMESCAN_ACTIVE, ns3::MLMESCAN_NO_BEACON, ns3::MLMESCAN_ORPHAN, ns3::MLMESCAN_PASSIVE, ns3::MLMESCAN_SUCCESS, NS_LOG_ERROR, NS_LOG_FUNCTION, and ns3::phyCurrentChannel.

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndStartRequest()

void ns3::LrWpanMac::EndStartRequest ( )

private

Called to end a MLME-START.request after changing the page and channel number.

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

References ns3::lrwpan::aBaseSuperframeDuration, ns3::EventId::Cancel(), ns3::IEEE_802_15_4_PHY_RX_ON, ns3::Callback< R, UArgs >::IsNull(), ns3::MlmeStartRequestParams::m_battLifeExt, ns3::MlmeStartRequestParams::m_bcnOrd, m_beaconEvent, m_beaconInterval, m_capEvent, m_cfpEvent, m_coor, ns3::MlmeStartRequestParams::m_coorRealgn, m_csmaCa, m_fnlCapSlot, m_incCapEvent, m_incCfpEvent, m_macBeaconOrder, m_macPanId, m_macSuperframeOrder, m_mlmeStartConfirmCallback, ns3::MlmeStartRequestParams::m_panCoor, m_panCoor, ns3::MlmeStartRequestParams::m_PanId, m_pendPrimitive, m_phy, m_scanEnergyEvent, m_scanEvent, m_scanOrphanEvent, ns3::MlmeStartRequestParams::m_sfrmOrd, m_startParams, ns3::MlmeStartConfirmParams::m_status, m_superframeDuration, m_trackingEvent, ns3::MLME_NONE, ns3::MLMESTART_SUCCESS, NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SendOneBeacon().

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnqueueInd()

void ns3::LrWpanMac::EnqueueInd ( Ptr< Packet > p )

private

Adds a packet to the pending transactions list (Indirect transmissions).

Parameters

p	The packet added to pending transaction list.

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

References ns3::lrwpan::aBaseSuperframeDuration, ns3::EXT_ADDR, ns3::LrWpanMacHeader::EXTADDR, ns3::LrWpanMacHeader::GetDstAddrMode(), ns3::LrWpanMacHeader::GetExtDstAddr(), ns3::LrWpanMacHeader::GetExtSrcAddr(), ns3::LrWpanMacHeader::GetSeqNum(), ns3::LrWpanMacHeader::GetShortDstAddr(), ns3::Callback< R, UArgs >::IsNull(), ns3::MlmeCommStatusIndicationParams::m_dstAddrMode, ns3::MlmeCommStatusIndicationParams::m_dstExtAddr, m_indTxQueue, m_macBeaconOrder, m_macIndTxDropTrace, m_macIndTxEnqueueTrace, m_macPanId, m_macTransactionPersistenceTime, m_maxIndTxQueueSize, m_mlmeCommStatusIndicationCallback, ns3::MlmeCommStatusIndicationParams::m_panId, m_phy, ns3::MlmeCommStatusIndicationParams::m_srcAddrMode, ns3::MlmeCommStatusIndicationParams::m_srcExtAddr, ns3::MlmeCommStatusIndicationParams::m_status, ns3::MLMECOMMSTATUS_TRANSACTION_OVERFLOW, ns3::Simulator::Now(), NS_ASSERT, PurgeInd(), ns3::Seconds(), and ns3::SHORT_ADDR.

Referenced by MlmeAssociateResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnqueueTxQElement()

void ns3::LrWpanMac::EnqueueTxQElement ( Ptr< TxQueueElement > txQElement )

private

Add an element to the transmission queue.

Parameters

txQElement The element added to the Tx Queue.

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

References ns3::IEEE_802_15_4_TRANSACTION_OVERFLOW, ns3::Callback< R, UArgs >::IsNull(), m_macTxDropTrace, m_macTxEnqueueTrace, m_maxTxQueueSize, m_mcpsDataConfirmCallback, ns3::McpsDataConfirmParams::m_msduHandle, ns3::McpsDataConfirmParams::m_status, m_txQueue, and NS_LOG_DEBUG.

Referenced by McpsDataRequest(), MlmeOrphanResponse(), SendAssocRequestCommand(), SendBeaconRequestCommand(), SendDataRequestCommand(), and SendOrphanNotificationCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAssociationStatus()

LrWpanAssociationStatus ns3::LrWpanMac::GetAssociationStatus ( ) const

Get the current association status.

Returns: current association status

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

References m_associationStatus.

◆ GetCoordExtAddress()

Mac64Address ns3::LrWpanMac::GetCoordExtAddress ( ) const

Get the coordinator extended address currently associated to this device.

Returns: The coordinator extended address

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

References m_macCoordExtendedAddress.

◆ GetCoordShortAddress()

Mac16Address ns3::LrWpanMac::GetCoordShortAddress ( ) const

Get the coordinator short address currently associated to this device.

Returns: The coordinator short address

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

References m_macCoordShortAddress.

◆ GetExtendedAddress()

Mac64Address ns3::LrWpanMac::GetExtendedAddress ( ) const

Get the extended address of this MAC.

Returns: the extended address

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

References m_selfExt, and NS_LOG_FUNCTION.

Referenced by McpsDataRequest(), MlmeAssociateResponse(), MlmeOrphanResponse(), PdDataIndication(), PrintPendTxQ(), PrintTxQueue(), SendAssocRequestCommand(), SendOneBeacon(), and SendOrphanNotificationCommand().

Here is the caller graph for this function:

◆ GetGtsFields()

GtsFields ns3::LrWpanMac::GetGtsFields ( )

private

Constructs the Guaranteed Time Slots (GTS) Fields from local information.

The GTS Fields are part of the beacon frame.

Returns: the Guaranteed Time Slots (GTS) Fields

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

Referenced by SendOneBeacon().

Here is the caller graph for this function:

◆ GetIfsSize()

uint32_t ns3::LrWpanMac::GetIfsSize ( )

Get the size of the Interframe Space according to MPDU size (m_txPkt).

Returns: the IFS size in symbols

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

References ns3::lrwpan::aMaxSIFSFrameSize, ns3::Packet::GetSize(), m_macLIFSPeriod, m_macSIFSPeriod, m_txPkt, and NS_ASSERT.

Referenced by PdDataConfirm(), and PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMacAckWaitDuration()

uint64_t ns3::LrWpanMac::GetMacAckWaitDuration ( ) const

Get the macAckWaitDuration attribute value.

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

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

References ns3::lrwpan::aTurnaroundTime, ns3::lrwpan::aUnitBackoffPeriod, and m_phy.

Referenced by PdDataConfirm().

Here is the caller graph for this function:

◆ GetMacMaxFrameRetries()

uint8_t ns3::LrWpanMac::GetMacMaxFrameRetries ( ) const

Get the macMaxFrameRetries attribute value.

Returns: the maximum number of retries

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

References m_macMaxFrameRetries.

◆ GetPanId()

uint16_t ns3::LrWpanMac::GetPanId ( ) const

Get the PAN id used by this MAC.

Returns: the PAN id.

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

References m_macPanId.

Referenced by McpsDataRequest(), and SendOneBeacon().

Here is the caller graph for this function:

◆ GetPendingAddrFields()

PendingAddrFields ns3::LrWpanMac::GetPendingAddrFields ( )

private

Constructs Pending Address Fields from the local information, the Pending Address Fields are part of the beacon frame.

Returns: the Pending Address Fields

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

Referenced by SendOneBeacon().

Here is the caller graph for this function:

◆ GetPhy()

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

Get the underlying PHY of the MAC.

Returns: the PHY

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

References m_phy.

◆ GetRxOnWhenIdle()

bool ns3::LrWpanMac::GetRxOnWhenIdle ( ) const

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 296 of file lr-wpan-mac.cc.

References m_macRxOnWhenIdle.

◆ GetShortAddress()

Mac16Address ns3::LrWpanMac::GetShortAddress ( ) const

Get the short address of this MAC.

Returns: the short address

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

References m_shortAddress, and NS_LOG_FUNCTION.

Referenced by McpsDataRequest(), MlmeOrphanResponse(), MlmeStartRequest(), PdDataConfirm(), PdDataIndication(), PrintPendTxQ(), PrintTxQueue(), and SendOneBeacon().

Here is the caller graph for this function:

◆ GetSuperframeField()

SuperframeField ns3::LrWpanMac::GetSuperframeField ( )

private

Constructs a Superframe specification field from the local information, the superframe Specification field is necessary to create a beacon frame.

Returns: the Superframe specification field

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

References m_csmaCa, m_fnlCapSlot, m_macAssociationPermit, m_macBeaconOrder, m_macSuperframeOrder, m_panCoor, ns3::SuperframeField::SetAssocPermit(), ns3::SuperframeField::SetBattLifeExt(), ns3::SuperframeField::SetBeaconOrder(), ns3::SuperframeField::SetFinalCapSlot(), ns3::SuperframeField::SetPanCoor(), and ns3::SuperframeField::SetSuperframeOrder().

Referenced by SendOneBeacon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxPacketSymbols()

uint64_t ns3::LrWpanMac::GetTxPacketSymbols ( )

Obtain the number of symbols in the packet which is currently being sent by the MAC layer.

Returns: packet number of symbols

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

References ns3::Packet::GetSize(), m_phy, m_txPkt, and NS_ASSERT.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::LrWpanMac::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

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

Here is the call graph for this function:

◆ IfsWaitTimeout()

void ns3::LrWpanMac::IfsWaitTimeout ( Time ifsTime )

private

After a successful transmission of a frame (beacon, data) or an ack frame reception, the mac layer wait an Interframe Space (IFS) time and triggers this function to continue with the MAC flow.

Parameters

ifsTime IFS time

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

References ns3::Time::As(), CheckQueue(), m_macIfsEndTrace, m_macLIFSPeriod, m_macSIFSPeriod, m_phy, NS_LOG_DEBUG, ns3::Time::S, and ns3::Seconds().

Referenced by PdDataConfirm(), and PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCoordDest()

bool ns3::LrWpanMac::isCoordDest ( )

Check if the packet destination is its coordinator.

Returns: True if m_txPkt (packet awaiting to be sent) destination is its coordinator

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

References ns3::LrWpanMacHeader::GetExtDstAddr(), ns3::LrWpanMacHeader::GetShortDstAddr(), m_coor, m_macCoordExtendedAddress, m_macCoordShortAddress, m_txPkt, NS_ASSERT, NS_LOG_DEBUG, and ns3::Packet::PeekHeader().

Here is the call graph for this function:

◆ isTxAckReq()

bool ns3::LrWpanMac::isTxAckReq ( )

Check if the packet to transmit requires acknowledgment.

Returns: True if the Tx packet requires acknowledgment

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

References ns3::LrWpanMacHeader::IsAckReq(), m_txPkt, NS_ASSERT, and ns3::Packet::PeekHeader().

Here is the call graph for this function:

◆ LostAssocRespCommand()

void ns3::LrWpanMac::LostAssocRespCommand ( )

private

Called after m_assocRespCmdWaitTime timeout while waiting for an association response command.

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

References ns3::Callback< R, UArgs >::IsNull(), ns3::MlmeAssociateConfirmParams::m_assocShortAddr, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macPanId, m_mlmeAssociateConfirmCallback, ns3::MlmeAssociateConfirmParams::m_status, and ns3::MLMEASSOC_NO_DATA.

Referenced by PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 349 of file lr-wpan-mac.cc.

Referenced by LrWpanDataIfsTestCase::DataReceivedDev1(), LrWpanAckTestCase::DoRun(), LrWpanCcaTestCase::DoRun(), LrWpanCollisionTestCase::DoRun(), LrWpanEdTestCase::DoRun(), LrWpanErrorDistanceTestCase::DoRun(), LrWpanDataIfsTestCase::DoRun(), TestRxOffWhenIdleAfterCsmaFailure::DoRun(), and LrWpanSlottedCsmacaTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmeAssociateRequest()

void ns3::LrWpanMac::MlmeAssociateRequest ( MlmeAssociateRequestParams params )

IEEE 802.15.4-2011, section 6.2.2.1 MLME-ASSOCIATE.request Request primitive used by a device to request an association with a coordinator.

Parameters

params the request parameters

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

References ns3::EXT_ADDR, ns3::Callback< R, UArgs >::IsNull(), m_associateParams, ns3::MlmeAssociateConfirmParams::m_assocShortAddr, m_mlmeAssociateConfirmCallback, m_pendPrimitive, m_phy, ns3::MlmeAssociateConfirmParams::m_status, ns3::MLME_ASSOC_REQ, ns3::MLME_NONE, ns3::MLMEASSOC_INVALID_PARAMETER, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::phyCurrentPage, and ns3::SHORT_ADDR.

Referenced by ScanConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmeAssociateResponse()

void ns3::LrWpanMac::MlmeAssociateResponse ( MlmeAssociateResponseParams params )

IEEE 802.15.4-2011, section 6.2.2.3 MLME-ASSOCIATE.response Primitive used to initiate a response to an MLME-ASSOCIATE.indication primitive.

Parameters

params the associate response parameters

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

Referenced by AssociateIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmeGetRequest()

void ns3::LrWpanMac::MlmeGetRequest ( LrWpanMacPibAttributeIdentifier id )

IEEE 802.15.4-2011, section 6.2.5.1 MLME-GET.request Request information about a given PIB attribute.

Parameters

id	the attribute identifier

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

References ns3::Callback< R, UArgs >::IsNull(), m_macBeaconPayload, m_macBeaconPayloadLength, m_macPanId, m_mlmeGetConfirmCallback, m_selfExt, m_shortAddress, ns3::macBeaconPayload, ns3::macBeaconPayloadLength, ns3::macExtendedAddress, ns3::macPanId, ns3::macShortAddress, ns3::MLMEGET_SUCCESS, and ns3::MLMEGET_UNSUPPORTED_ATTRIBUTE.

Here is the call graph for this function:

◆ MlmeOrphanResponse()

void ns3::LrWpanMac::MlmeOrphanResponse ( MlmeOrphanResponseParams params )

IEEE 802.15.4-2011, section 6.2.7.2 MLME-ORPHAN.response Primitive used to initiatte a response to an MLME-ORPHAN.indication primitive.

Parameters

params the orphan response parameters

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

Referenced by OrphanIndication(), and TestOrphanScan::OrphanIndicationCoord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmePollRequest()

void ns3::LrWpanMac::MlmePollRequest ( MlmePollRequestParams params )

IEEE 802.15.4-2011, section 6.2.14.2 MLME-POLL.request Prompts the device to request data from the coordinator.

Parameters

params the request parameters

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

References ns3::CommandPayloadHeader::DATA_REQ, ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), ns3::LrWpanMacHeader::LRWPAN_MAC_COMMAND, m_macBsn, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ MlmeScanRequest()

void ns3::LrWpanMac::MlmeScanRequest ( MlmeScanRequestParams params )

IEEE 802.15.4-2011, section 6.2.10.1 MLME-SCAN.request Request primitive used to initiate a channel scan over a given list of channels.

Parameters

params the scan request parameters

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

References ns3::EventId::Cancel(), ns3::Callback< R, UArgs >::IsNull(), ns3::EventId::IsRunning(), m_capEvent, m_cfpEvent, m_channelScanIndex, ns3::MlmeScanConfirmParams::m_chPage, m_csmaCa, m_energyDetectList, m_incCapEvent, m_incCfpEvent, m_macPanId, m_macPanIdScan, m_mlmeScanConfirmCallback, m_panDescriptorList, m_pendPrimitive, m_phy, m_scanEnergyEvent, m_scanEvent, m_scanOrphanEvent, m_scanParams, ns3::MlmeScanConfirmParams::m_scanType, ns3::MlmeScanConfirmParams::m_status, m_trackingEvent, m_unscannedChannels, ns3::MLME_SCAN_REQ, ns3::MLMESCAN_INVALID_PARAMETER, ns3::MLMESCAN_ORPHAN, ns3::MLMESCAN_SCAN_IN_PROGRESS, NS_LOG_ERROR, NS_LOG_FUNCTION, and ns3::phyCurrentPage.

Referenced by TestActiveScanPanDescriptors::DoRun(), and TestOrphanScan::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmeSetRequest()

void ns3::LrWpanMac::MlmeSetRequest	(	LrWpanMacPibAttributeIdentifier	id,
		Ptr< LrWpanMacPibAttributes >	attribute
	)

IEEE 802.15.4-2011, section 6.2.11.1 MLME-SET.request Attempts to write the given value to the indicated PIB attribute.

Parameters

id	the attributed identifier
attribute	the attribute value

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

References ns3::lrwpan::aMaxBeaconPayloadLength, ns3::MlmeSetConfirmParams::id, ns3::Callback< R, UArgs >::IsNull(), m_macBeaconPayload, m_macBeaconPayloadLength, m_macPanId, m_mlmeSetConfirmCallback, m_shortAddress, ns3::MlmeSetConfirmParams::m_status, ns3::macBeaconPayload, ns3::macBeaconPayloadLength, ns3::macExtendedAddress, ns3::macPanId, ns3::macShortAddress, ns3::MLMESET_INVALID_PARAMETER, ns3::MLMESET_READ_ONLY, ns3::MLMESET_SUCCESS, and ns3::MLMESET_UNSUPPORTED_ATTRIBUTE.

Here is the call graph for this function:

◆ MlmeStartRequest()

void ns3::LrWpanMac::MlmeStartRequest ( MlmeStartRequestParams params )

IEEE 802.15.4-2006, section 7.1.14.1 MLME-START.request Request to allow a PAN coordinator to initiate a new PAN or beginning a new superframe configuration.

Parameters

params the request parameters

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

References ns3::FFD, GetShortAddress(), ns3::Callback< R, UArgs >::IsNull(), m_deviceCapability, ns3::MlmeStartRequestParams::m_logChPage, m_mlmeStartConfirmCallback, m_pendPrimitive, m_phy, m_startParams, ns3::MlmeStartConfirmParams::m_status, ns3::MLME_START_REQ, ns3::MLMESTART_INVALID_PARAMETER, ns3::MLMESTART_NO_SHORT_ADDRESS, NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, and ns3::phyCurrentPage.

Referenced by TestActiveScanPanDescriptors::DoRun(), TestOrphanScan::DoRun(), and LrWpanSlottedCsmacaTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MlmeSyncRequest()

void ns3::LrWpanMac::MlmeSyncRequest ( MlmeSyncRequestParams params )

IEEE 802.15.4-2011, section 6.2.13.1 MLME-SYNC.request Request to synchronize with the coordinator by acquiring and, if specified, tracking beacons.

Parameters

params the request parameters

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

References ns3::lrwpan::aBaseSuperframeDuration, BeaconSearchTimeout(), ns3::EventId::Cancel(), ns3::IEEE_802_15_4_PHY_RX_ON, ns3::EventId::IsRunning(), m_beaconTrackingOn, m_incomingBeaconOrder, m_macPanId, m_numLostBeacons, m_phy, m_trackingEvent, NS_ASSERT, NS_LOG_FUNCTION, ns3::phyCurrentChannel, ns3::Simulator::Schedule(), and ns3::Seconds().

Here is the call graph for this function:

◆ 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 3051 of file lr-wpan-mac.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1857 of file lr-wpan-mac.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 3298 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 3306 of file lr-wpan-mac.cc.

References ns3::Simulator::GetDelayLeft(), m_maxEnergyLevel, m_phy, m_scanEnergyEvent, NS_LOG_FUNCTION, and ns3::Seconds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PlmeGetAttributeConfirm()

void ns3::LrWpanMac::PlmeGetAttributeConfirm	(	LrWpanPhyEnumeration	status,
		LrWpanPibAttributeIdentifier	id,
		Ptr< 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 3323 of file lr-wpan-mac.cc.

References NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ 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 3382 of file lr-wpan-mac.cc.

References ns3::lrwpan::aBaseSuperframeDuration, ns3::EventId::Cancel(), EndAssociateRequest(), EndChannelEnergyScan(), EndChannelScan(), EndStartRequest(), ns3::IEEE_802_15_4_PHY_RX_ON, ns3::IEEE_802_15_4_PHY_SUCCESS, ns3::Callback< R, UArgs >::IsNull(), m_associateParams, ns3::MlmeAssociateConfirmParams::m_assocShortAddr, m_channelScanIndex, ns3::MlmeAssociateRequestParams::m_chNum, ns3::MlmeScanRequestParams::m_chPage, ns3::MlmeScanConfirmParams::m_chPage, m_csmaCa, m_incCapEvent, m_incCfpEvent, m_incomingBeaconOrder, m_incomingSuperframeOrder, ns3::MlmeStartRequestParams::m_logCh, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macPanId, m_macResponseWaitTime, m_maxEnergyLevel, m_mlmeAssociateConfirmCallback, m_mlmeScanConfirmCallback, m_mlmeStartConfirmCallback, m_pendPrimitive, m_phy, ns3::MlmeScanRequestParams::m_scanChannels, ns3::MlmeScanRequestParams::m_scanDuration, m_scanEnergyEvent, m_scanEvent, m_scanOrphanEvent, m_scanParams, ns3::MlmeScanRequestParams::m_scanType, ns3::MlmeScanConfirmParams::m_scanType, m_startParams, ns3::MlmeScanConfirmParams::m_status, ns3::MlmeAssociateConfirmParams::m_status, ns3::MlmeStartConfirmParams::m_status, ns3::MLME_ASSOC_REQ, ns3::MLME_SCAN_REQ, ns3::MLME_START_REQ, ns3::MLMEASSOC_INVALID_PARAMETER, ns3::MLMESCAN_ACTIVE, ns3::MLMESCAN_ED, ns3::MLMESCAN_INVALID_PARAMETER, ns3::MLMESCAN_ORPHAN, ns3::MLMESCAN_PASSIVE, ns3::MLMESTART_INVALID_PARAMETER, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::phyCurrentChannel, ns3::phyCurrentPage, ns3::Simulator::Schedule(), ns3::Seconds(), SendBeaconRequestCommand(), and SendOrphanNotificationCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 3331 of file lr-wpan-mac.cc.

References CheckQueue(), 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, ns3::EventId::IsRunning(), m_csmaCa, m_lrWpanMacState, m_macTxTrace, m_phy, m_promiscSnifferTrace, m_scanEnergyEvent, 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrepareRetransmission()

bool ns3::LrWpanMac::PrepareRetransmission ( )

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 2707 of file lr-wpan-mac.cc.

References ns3::CommandPayloadHeader::ASSOCIATION_REQ, ns3::CommandPayloadHeader::ASSOCIATION_RESP, ns3::EventId::Cancel(), ns3::Packet::Copy(), ns3::CommandPayloadHeader::DATA_REQ, ns3::LrWpanMacHeader::EXTADDR, ns3::CommandPayloadHeader::GetCommandFrameType(), ns3::LrWpanMacHeader::GetExtDstAddr(), ns3::LrWpanMacHeader::GetExtSrcAddr(), ns3::IEEE_802_15_4_NO_ACK, ns3::LrWpanMacHeader::IsCommand(), ns3::Callback< R, UArgs >::IsNull(), ns3::MlmeAssociateConfirmParams::m_assocShortAddr, m_csmaCa, ns3::MlmeCommStatusIndicationParams::m_dstAddrMode, ns3::MlmeCommStatusIndicationParams::m_dstExtAddr, m_incCapEvent, m_incCfpEvent, m_incomingBeaconOrder, m_incomingSuperframeOrder, m_macCoordExtendedAddress, m_macCoordShortAddress, m_macMaxFrameRetries, m_macPanId, m_macTxDropTrace, m_mcpsDataConfirmCallback, m_mlmeAssociateConfirmCallback, m_mlmeCommStatusIndicationCallback, m_mlmePollConfirmCallback, ns3::McpsDataConfirmParams::m_msduHandle, m_numCsmacaRetry, ns3::MlmeCommStatusIndicationParams::m_panId, m_retransmission, ns3::MlmeCommStatusIndicationParams::m_srcAddrMode, ns3::MlmeCommStatusIndicationParams::m_srcExtAddr, ns3::McpsDataConfirmParams::m_status, ns3::MlmeAssociateConfirmParams::m_status, ns3::MlmeCommStatusIndicationParams::m_status, ns3::MlmePollConfirmParams::m_status, m_txPkt, m_txQueue, ns3::MLMEASSOC_NO_ACK, ns3::MLMECOMMSTATUS_NO_ACK, ns3::MLMEPOLL_NO_ACK, NS_LOG_FUNCTION, ns3::Packet::PeekHeader(), RemoveFirstTxQElement(), and RemovePendTxQElement().

Referenced by AckWaitTimeout(), and PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintPendTxQ()

void ns3::LrWpanMac::PrintPendTxQ ( std::ostream & os ) const

Print the Pending transaction list.

Parameters

os	The reference to the output stream used by this print function.

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

References ns3::Time::As(), GetExtendedAddress(), GetShortAddress(), ns3::LrWpanMacHeader::IsCommand(), ns3::LrWpanMacHeader::IsData(), m_indTxQueue, ns3::Simulator::Now(), and ns3::Time::S.

Here is the call graph for this function:

◆ PrintTransmitQueueSize()

void ns3::LrWpanMac::PrintTransmitQueueSize ( )

Print the number of elements in the packet transmit queue.

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

References m_txQueue, and NS_LOG_DEBUG.

◆ PrintTxQueue()

void ns3::LrWpanMac::PrintTxQueue ( std::ostream & os ) const

Print the Transmit Queue.

Parameters

os	The reference to the output stream used by this print function.

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

References ns3::Time::As(), ns3::LrWpanMacHeader::GetDstPanId(), ns3::LrWpanMacHeader::GetExtDstAddr(), GetExtendedAddress(), ns3::LrWpanMacHeader::GetSeqNum(), GetShortAddress(), ns3::LrWpanMacHeader::GetShortDstAddr(), ns3::LrWpanMacHeader::IsCommand(), ns3::LrWpanMacHeader::IsData(), m_indTxQueue, m_txQueue, ns3::Simulator::Now(), and ns3::Time::S.

Here is the call graph for this function:

◆ PurgeInd()

void ns3::LrWpanMac::PurgeInd ( )

private

Purge expired transactions from the pending transactions list.

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

References ns3::LrWpanMacHeader::EXTADDR, ns3::LrWpanMacHeader::GetExtDstAddr(), ns3::LrWpanMacHeader::GetExtSrcAddr(), ns3::IEEE_802_15_4_TRANSACTION_EXPIRED, ns3::LrWpanMacHeader::IsCommand(), ns3::LrWpanMacHeader::IsData(), ns3::Callback< R, UArgs >::IsNull(), ns3::MlmeCommStatusIndicationParams::m_dstAddrMode, ns3::MlmeCommStatusIndicationParams::m_dstExtAddr, m_indTxQueue, m_macIndTxDropTrace, m_macPanId, m_mcpsDataConfirmCallback, m_mlmeCommStatusIndicationCallback, ns3::MlmeCommStatusIndicationParams::m_panId, ns3::MlmeCommStatusIndicationParams::m_srcAddrMode, ns3::MlmeCommStatusIndicationParams::m_srcExtAddr, ns3::McpsDataConfirmParams::m_status, ns3::MlmeCommStatusIndicationParams::m_status, ns3::MLMECOMMSTATUS_TRANSACTION_EXPIRED, and ns3::Simulator::Now().

Referenced by DequeueInd(), and EnqueueInd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 2639 of file lr-wpan-mac.cc.

References ns3::LrWpanMacHeader::GetShortDstAddr(), ns3::Mac16Address::IsBroadcast(), ns3::Mac16Address::IsMulticast(), m_csmaCa, m_macTxDequeueTrace, m_numCsmacaRetry, m_retransmission, m_sentPktTrace, m_txPkt, and m_txQueue.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemovePendTxQElement()

void ns3::LrWpanMac::RemovePendTxQElement ( Ptr< Packet > p )

private

Remove an element from the pending transaction list.

Parameters

p	The packet to be removed from the pending transaction list.

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

References ns3::EXT_ADDR, ns3::LrWpanMacHeader::GetDstAddrMode(), ns3::LrWpanMacHeader::GetExtDstAddr(), ns3::LrWpanMacHeader::GetSeqNum(), ns3::LrWpanMacHeader::GetShortDstAddr(), m_indTxQueue, m_macIndTxDequeueTrace, and ns3::SHORT_ADDR.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 2588 of file lr-wpan-mac.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendAssocRequestCommand()

void ns3::LrWpanMac::SendAssocRequestCommand ( )

private

Called to send an associate request command.

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

Referenced by EndAssociateRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendAssocResponseCommand()

void ns3::LrWpanMac::SendAssocResponseCommand ( Ptr< Packet > rxDataReqPkt )

private

Called to send an associate response command.

Parameters

rxDataReqPkt The received data request pkt that instigated the Association response command.

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

References ns3::CommandPayloadHeader::DATA_REQ, DequeueInd(), ns3::CommandPayloadHeader::GetCommandFrameType(), ns3::LrWpanMacHeader::GetExtSrcAddr(), m_txQueue, NS_ASSERT, and NS_LOG_DEBUG.

Referenced by PdDataConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendBeaconRequestCommand()

void ns3::LrWpanMac::SendBeaconRequestCommand ( )

private

Called to send a beacon request command.

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

References ns3::CommandPayloadHeader::BEACON_REQ, CheckQueue(), ns3::Node::ChecksumEnabled(), ns3::LrWpanMacTrailer::EnableFcs(), EnqueueTxQElement(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), ns3::LrWpanMacHeader::LRWPAN_MAC_COMMAND, m_macDsn, ns3::LrWpanMacHeader::NOADDR, NS_LOG_FUNCTION, ns3::CommandPayloadHeader::SetCommandFrameType(), ns3::LrWpanMacHeader::SetDstAddrFields(), ns3::LrWpanMacHeader::SetDstAddrMode(), ns3::LrWpanMacTrailer::SetFcs(), ns3::LrWpanMacHeader::SetNoAckReq(), ns3::LrWpanMacHeader::SetNoPanIdComp(), ns3::LrWpanMacHeader::SetSecDisable(), ns3::LrWpanMacHeader::SetSrcAddrMode(), and ns3::LrWpanMacHeader::SHORTADDR.

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendDataRequestCommand()

void ns3::LrWpanMac::SendDataRequestCommand ( )

private

Used to send a data request command (i.e.

Request the coordinator to send the association response)

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

Referenced by PdDataIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendOneBeacon()

void ns3::LrWpanMac::SendOneBeacon ( )

private

Called to send a single beacon frame.

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

Referenced by EndStartRequest(), PdDataIndication(), and StartInactivePeriod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendOrphanNotificationCommand()

void ns3::LrWpanMac::SendOrphanNotificationCommand ( )

private

Called to send a orphan notification command.

This is used by an associated device that has lost synchronization with its coordinator. As described in IEEE 802.15.4-2011 (Section 5.3.6)

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

Referenced by PlmeSetAttributeConfirm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAssociatedCoor() [1/2]

void ns3::LrWpanMac::SetAssociatedCoor ( Mac16Address mac )

Check if the packet destination is its coordinator.

Parameters

mac	The coordinator short MAC Address

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

References m_macCoordShortAddress.

◆ SetAssociatedCoor() [2/2]

void ns3::LrWpanMac::SetAssociatedCoor ( Mac64Address mac )

Check if the packet destination is its coordinator.

Parameters

mac	The coordinator extended MAC Address

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

References m_macCoordExtendedAddress.

◆ SetAssociationStatus()

void ns3::LrWpanMac::SetAssociationStatus ( LrWpanAssociationStatus

Classes

Public Types

Public Member Functions

Static Public Member Functions

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

◆ AwaitBeacon()

◆ BeaconSearchTimeout()

◆ ChangeMacState()

◆ CheckQueue()

◆ DequeueInd()

◆ DoDispose()

◆ DoInitialize()

◆ EndAssociateRequest()

◆ EndChannelEnergyScan()

◆ EndChannelScan()

◆ EndStartRequest()

◆ EnqueueInd()

◆ EnqueueTxQElement()

◆ GetAssociationStatus()

◆ GetCoordExtAddress()

◆ GetCoordShortAddress()

◆ GetExtendedAddress()

◆ GetGtsFields()

◆ GetIfsSize()

◆ GetMacAckWaitDuration()

◆ GetMacMaxFrameRetries()

◆ GetPanId()

◆ GetPendingAddrFields()

◆ GetPhy()

◆ GetRxOnWhenIdle()

◆ GetShortAddress()

◆ GetSuperframeField()

◆ GetTxPacketSymbols()

◆ GetTypeId()

◆ IfsWaitTimeout()

◆ isCoordDest()

◆ isTxAckReq()

◆ LostAssocRespCommand()

◆ McpsDataRequest()

◆ MlmeAssociateRequest()

◆ MlmeAssociateResponse()

◆ MlmeGetRequest()

◆ MlmeOrphanResponse()

◆ MlmePollRequest()

◆ MlmeScanRequest()

◆ MlmeSetRequest()

◆ MlmeStartRequest()

◆ MlmeSyncRequest()

◆ PdDataConfirm()

◆ PdDataIndication()

◆ PlmeCcaConfirm()

◆ PlmeEdConfirm()

◆ PlmeGetAttributeConfirm()

◆ PlmeSetAttributeConfirm()

◆ PlmeSetTRXStateConfirm()

◆ PrepareRetransmission()

◆ PrintPendTxQ()

◆ PrintTransmitQueueSize()

◆ PrintTxQueue()

◆ PurgeInd()

◆ RemoveFirstTxQElement()

◆ RemovePendTxQElement()

◆ SendAck()

◆ SendAssocRequestCommand()