A Discrete-Event Network Simulator
API
ns3::dot11s::PeerManagementProtocol Class Reference

802.11s Peer Management Protocol model More...

#include "peer-management-protocol.h"

+ Inheritance diagram for ns3::dot11s::PeerManagementProtocol:
+ Collaboration diagram for ns3::dot11s::PeerManagementProtocol:

Classes

struct  BeaconInfo
 Keeps information about beacon of peer station: beacon interval, association ID, last time we have received a beacon. More...
 
struct  Statistics
 Statistics structure. More...
 

Public Types

typedef void(* LinkOpenCloseTracedCallback) (Mac48Address src, const Mac48Address dst)
 TracedCallback signature for link open/close events. More...
 

Public Member Functions

 PeerManagementProtocol ()
 
 ~PeerManagementProtocol ()
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void DoDispose ()
 Destructor implementation. More...
 
bool Install (Ptr< MeshPointDevice > mp)
 Install PMP on given mesh point. More...
 
void Report (std::ostream &os) const
 Report statistics. More...
 
void ResetStats ()
 Reset statistics function. More...
 
This methods interact with MAC_layer plug-in

Methods that handle beacon sending/receiving procedure.

Ptr< IeBeaconTimingGetBeaconTimingElement (uint32_t interface)
 When we are sending a beacon - we fill beacon timing element. More...
 
void ReceiveBeacon (uint32_t interface, Mac48Address peerAddress, Time beaconInterval, Ptr< IeBeaconTiming > beaconTiming)
 To initiate peer link we must notify about received beacon. More...
 
Methods that handle Peer link management frames interaction:
void ReceivePeerLinkFrame (uint32_t interface, Mac48Address peerAddress, Mac48Address peerMeshPointAddress, uint16_t aid, IePeerManagement peerManagementElement, IeConfiguration meshConfig)
 Deliver Peer link management information to the protocol-part. More...
 
void ConfigurationMismatch (uint32_t interface, Mac48Address peerAddress)
 Cancels peer link due to broken configuration (Mesh ID or Supported rates) More...
 
void TransmissionFailure (uint32_t interface, const Mac48Address peerAddress)
 Cancels peer link due to successive transmission failures. More...
 
void TransmissionSuccess (uint32_t interface, const Mac48Address peerAddress)
 resets transmission failure statistics More...
 
bool IsActiveLink (uint32_t interface, Mac48Address peerAddress)
 Checks if there is established link. More...
 
Interface to other protocols (MLME)
void SetPeerLinkStatusCallback (Callback< void, Mac48Address, Mac48Address, uint32_t, bool > cb)
 Set peer link status change callback. More...
 
Ptr< PeerLinkFindPeerLink (uint32_t interface, Mac48Address peerAddress)
 Find active peer link by my interface and peer interface MAC. More...
 
std::vector< Ptr< PeerLink > > GetPeerLinks () const
 Get list of all active peer links. More...
 
std::vector< Mac48AddressGetPeers (uint32_t interface) const
 Get list of active peers of my given interface. More...
 
Mac48Address GetAddress ()
 Get mesh point address. More...
 
uint8_t GetNumberOfLinks ()
 Get number of links. More...
 
void SetMeshId (std::string s)
 Set mesh ID to a string value. More...
 
Ptr< IeMeshIdGetMeshId () const
 Get mesh ID information element. More...
 
void SetBeaconCollisionAvoidance (bool enable)
 Enable or disable beacon collision avoidance. More...
 
bool GetBeaconCollisionAvoidance () const
 Get beacon collision avoidance. More...
 
void NotifyBeaconSent (uint32_t interface, Time beaconInterval)
 Notify about beacon send event, needed to schedule BCA. 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 ()
 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...
 

Private Types

typedef std::map< uint32_t, BeaconsOnInterfaceBeaconInfoMap
 This map keeps beacon information on all interfaces. More...
 
typedef std::map< Mac48Address, BeaconInfoBeaconsOnInterface
 This map keeps relationship between peer address and its beacon information. More...
 
typedef std::map< uint32_t, PeerLinksOnInterfacePeerLinksMap
 This map keeps all peer links. More...
 
typedef std::vector< Ptr< PeerLink > > PeerLinksOnInterface
 We keep a vector of pointers to PeerLink class. More...
 
typedef std::map< uint32_t, Ptr< PeerManagementProtocolMac > > PeerManagementProtocolMacMap
 this vector keeps pointers to MAC-plugins More...
 

Private Member Functions

 PeerManagementProtocol (const PeerManagementProtocol &)
 type conversion operator More...
 
void CheckBeaconCollisions (uint32_t interface)
 BCA. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
Ptr< PeerLinkInitiateLink (uint32_t interface, Mac48Address peerAddress, Mac48Address peerMeshPointAddress)
 Initiate link function. More...
 
void NotifyLinkClose (Mac48Address peerMp, Mac48Address peerIface, Mac48Address myIface, uint32_t interface)
 Aux. More...
 
void NotifyLinkOpen (Mac48Address peerMp, Mac48Address peerIface, Mac48Address myIface, uint32_t interface)
 Aux. More...
 
PeerManagementProtocoloperator= (const PeerManagementProtocol &peer)
 assignment operator More...
 
void PeerLinkStatus (uint32_t interface, Mac48Address peerAddress, Mac48Address peerMeshPointAddres, PeerLink::PeerState ostate, PeerLink::PeerState nstate)
 Indicates changes in peer links. More...
 
void ShiftOwnBeacon (uint32_t interface)
 Shift own beacon function. More...
 
bool ShouldAcceptOpen (uint32_t interface, Mac48Address peerAddress, PmpReasonCode &reasonCode)
 External peer-chooser. More...
 
bool ShouldSendOpen (uint32_t interface, Mac48Address peerAddress)
 External peer-chooser. More...
 
int TimeToTu (Time x)
 Time<-->TU converters: More...
 
Time TuToTime (int x)
 Time<-->TU converters: More...
 

Private Attributes

Mac48Address m_address
 address More...
 
std::map< uint32_t, Timem_beaconInterval
 Beacon interval at each interface. More...
 
bool m_enableBca
 Flag which enables BCA. More...
 
uint16_t m_lastAssocId
 last associated ID More...
 
std::map< uint32_t, Timem_lastBeacon
 Last beacon at each interface. More...
 
uint16_t m_lastLocalLinkId
 last local link ID More...
 
uint16_t m_maxBeaconShift
 Beacon can be shifted at [-m_maxBeaconShift; +m_maxBeaconShift] TUs. More...
 
uint8_t m_maxNumberOfPeerLinks
 maimum number of peer links More...
 
Ptr< IeMeshIdm_meshId
 mesh ID More...
 
PeerManagementProtocolMacMap m_plugins
 plugins More...
 

Peer Links

typedef TracedCallback< Mac48Address, Mac48AddressLinkEventCallback
 Simple link open/close trace source type. Addresses are: src interface, dst interface. More...
 
PeerLinksMap m_peerLinks
 Simple link open/close trace source type. Addresses are: src interface, dst interface. More...
 
Callback< void, Mac48Address, Mac48Address, uint32_t, bool > m_peerStatusCallback
 Callback to notify about peer link changes: Mac48Address is peer address of mesh point, Mac48Address is peer address of interface, uint32_t - interface ID, bool is status - true when new link has appeared, false - when link was closed,. More...
 
LinkEventCallback m_linkOpenTraceSrc
 LinkOpen trace source. More...
 
LinkEventCallback m_linkCloseTraceSrc
 LinkClose trace source. More...
 
struct Statistics m_stats
 statistics More...
 
Ptr< UniformRandomVariablem_beaconShift
 Add randomness to beacon shift. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. 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...
 

Detailed Description

802.11s Peer Management Protocol model

Introspection did not find any typical Config paths.


Attributes

  • MaxNumberOfPeerLinks: Maximum number of peer links
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 32
    • Flags: construct write read
  • MaxBeaconShiftValue: Maximum number of TUs for beacon shifting
    • Set with class: ns3::UintegerValue
    • Underlying type: uint16_t 0:65535
    • Initial value: 15
    • Flags: construct write read
  • EnableBeaconCollisionAvoidance: Enable/Disable Beacon collision avoidance.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources

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

Definition at line 49 of file peer-management-protocol.h.

Member Typedef Documentation

◆ BeaconInfoMap

This map keeps beacon information on all interfaces.

Definition at line 253 of file peer-management-protocol.h.

◆ BeaconsOnInterface

This map keeps relationship between peer address and its beacon information.

Definition at line 251 of file peer-management-protocol.h.

◆ LinkEventCallback

Simple link open/close trace source type. Addresses are: src interface, dst interface.

Definition at line 375 of file peer-management-protocol.h.

◆ LinkOpenCloseTracedCallback

typedef void(* ns3::dot11s::PeerManagementProtocol::LinkOpenCloseTracedCallback) (Mac48Address src, const Mac48Address dst)

TracedCallback signature for link open/close events.

Parameters
[in]srcMAC address of source interface.
[in]dstMAC address of destination interface.

Definition at line 230 of file peer-management-protocol.h.

◆ PeerLinksMap

This map keeps all peer links.

Definition at line 249 of file peer-management-protocol.h.

◆ PeerLinksOnInterface

We keep a vector of pointers to PeerLink class.

This vector keeps all peer links at a given interface.

Definition at line 247 of file peer-management-protocol.h.

◆ PeerManagementProtocolMacMap

this vector keeps pointers to MAC-plugins

Definition at line 255 of file peer-management-protocol.h.

Constructor & Destructor Documentation

◆ PeerManagementProtocol() [1/2]

ns3::dot11s::PeerManagementProtocol::PeerManagementProtocol ( )

Definition at line 91 of file peer-management-protocol.cc.

References m_beaconShift.

◆ ~PeerManagementProtocol()

ns3::dot11s::PeerManagementProtocol::~PeerManagementProtocol ( )

Definition at line 96 of file peer-management-protocol.cc.

References m_meshId.

◆ PeerManagementProtocol() [2/2]

ns3::dot11s::PeerManagementProtocol::PeerManagementProtocol ( const PeerManagementProtocol )
private

type conversion operator

Member Function Documentation

◆ AssignStreams()

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

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 590 of file peer-management-protocol.cc.

References m_beaconShift, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ CheckBeaconCollisions()

void ns3::dot11s::PeerManagementProtocol::CheckBeaconCollisions ( uint32_t  interface)
private

BCA.

Parameters
interfaceinterface

Definition at line 384 of file peer-management-protocol.cc.

References GetBeaconCollisionAvoidance(), m_beaconInterval, m_lastBeacon, m_maxBeaconShift, m_peerLinks, m_plugins, NS_ASSERT, NS_ASSERT_MSG, ShiftOwnBeacon(), TimeToTu(), and TuToTime().

Referenced by NotifyBeaconSent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ConfigurationMismatch()

void ns3::dot11s::PeerManagementProtocol::ConfigurationMismatch ( uint32_t  interface,
Mac48Address  peerAddress 
)

Cancels peer link due to broken configuration (Mesh ID or Supported rates)

Parameters
interfaceinterface of the link to cancel
peerAddresspeer address of the link to cancel

Definition at line 241 of file peer-management-protocol.cc.

References FindPeerLink(), and ns3::dot11s::REASON11S_MESH_CAPABILITY_POLICY_VIOLATION.

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::dot11s::PeerManagementProtocol::DoDispose ( void  )
virtual

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 101 of file peer-management-protocol.cc.

References m_peerLinks, and m_plugins.

◆ DoInitialize()

void ns3::dot11s::PeerManagementProtocol::DoInitialize ( void  )
privatevirtual

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 598 of file peer-management-protocol.cc.

References m_beaconShift, m_maxBeaconShift, and ns3::ObjectBase::SetAttribute().

+ Here is the call graph for this function:

◆ FindPeerLink()

Ptr< PeerLink > ns3::dot11s::PeerManagementProtocol::FindPeerLink ( uint32_t  interface,
Mac48Address  peerAddress 
)

Find active peer link by my interface and peer interface MAC.

Parameters
interfaceinterface of the link to find
peerAddresspeer address of the link to find
Returns
The peer link (null if not found)

Definition at line 296 of file peer-management-protocol.cc.

References m_peerLinks, and NS_ASSERT.

Referenced by ConfigurationMismatch(), InitiateLink(), IsActiveLink(), PeerLinkStatus(), ReceiveBeacon(), ReceivePeerLinkFrame(), TransmissionFailure(), and TransmissionSuccess().

+ Here is the caller graph for this function:

◆ GetAddress()

Mac48Address ns3::dot11s::PeerManagementProtocol::GetAddress ( void  )

Get mesh point address.

Todo:
this used by plugins only. Now MAC plugins can ask MP address directly from main MAC
Returns
Mac48Address

Definition at line 537 of file peer-management-protocol.cc.

References m_address.

Referenced by TransmissionFailure(), and TransmissionSuccess().

+ Here is the caller graph for this function:

◆ GetBeaconCollisionAvoidance()

bool ns3::dot11s::PeerManagementProtocol::GetBeaconCollisionAvoidance ( ) const

Get beacon collision avoidance.

Returns
the beacon collision avoidance flag

Definition at line 613 of file peer-management-protocol.cc.

References m_enableBca.

Referenced by CheckBeaconCollisions(), GetBeaconTimingElement(), GetTypeId(), and ReceiveBeacon().

+ Here is the caller graph for this function:

◆ GetBeaconTimingElement()

Ptr< IeBeaconTiming > ns3::dot11s::PeerManagementProtocol::GetBeaconTimingElement ( uint32_t  interface)

When we are sending a beacon - we fill beacon timing element.

Returns
IeBeaconTiming is a beacon timing element that should be present in beacon
Parameters
interfaceis a interface sending a beacon

Definition at line 146 of file peer-management-protocol.cc.

References GetBeaconCollisionAvoidance(), m_peerLinks, NS_ASSERT, and ns3::Seconds().

+ Here is the call graph for this function:

◆ GetMeshId()

Ptr< IeMeshId > ns3::dot11s::PeerManagementProtocol::GetMeshId ( ) const

Get mesh ID information element.

Returns
the mesh ID information element

Definition at line 526 of file peer-management-protocol.cc.

References m_meshId, and NS_ASSERT.

◆ GetNumberOfLinks()

uint8_t ns3::dot11s::PeerManagementProtocol::GetNumberOfLinks ( )

Get number of links.

Returns
the number of links

Definition at line 521 of file peer-management-protocol.cc.

References ns3::dot11s::PeerManagementProtocol::Statistics::linksTotal, and m_stats.

◆ GetPeerLinks()

std::vector< Ptr< PeerLink > > ns3::dot11s::PeerManagementProtocol::GetPeerLinks ( ) const

Get list of all active peer links.

Returns
a list of all the active peer links

Definition at line 342 of file peer-management-protocol.cc.

References m_peerLinks.

◆ GetPeers()

std::vector< Mac48Address > ns3::dot11s::PeerManagementProtocol::GetPeers ( uint32_t  interface) const

Get list of active peers of my given interface.

Parameters
interfacethe interface
Returns
a list of all the active peer links on an interface

Definition at line 326 of file peer-management-protocol.cc.

References m_peerLinks, and NS_ASSERT.

Referenced by ns3::Dot11sStack::InstallStack().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::dot11s::PeerManagementProtocol::GetTypeId ( void  )
static

◆ InitiateLink()

Ptr< PeerLink > ns3::dot11s::PeerManagementProtocol::InitiateLink ( uint32_t  interface,
Mac48Address  peerAddress,
Mac48Address  peerMeshPointAddress 
)
private

Initiate link function.

Parameters
interfacethe interface to use
peerAddressthe peer address
peerMeshPointAddressthe peer mesh point address
Returns
the peer link

Definition at line 270 of file peer-management-protocol.cc.

References FindPeerLink(), m_lastAssocId, m_lastLocalLinkId, m_peerLinks, m_plugins, ns3::MakeCallback(), NS_ASSERT, NS_FATAL_ERROR, and PeerLinkStatus().

Referenced by ReceiveBeacon(), and ReceivePeerLinkFrame().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Install()

bool ns3::dot11s::PeerManagementProtocol::Install ( Ptr< MeshPointDevice mp)

Install PMP on given mesh point.

Parameters
mpthe MeshPointDevice to install onto
Returns
true if successful

Installing protocol causes installation of its interface MAC plugins.

Also MP aggregates all installed protocols, PMP protocol can be accessed via MeshPointDevice::GetObject<PeerManagementProtocol>();

Definition at line 118 of file peer-management-protocol.cc.

References ns3::Mac48Address::ConvertFrom(), ns3::WifiNetDevice::GetMac(), ns3::Object::GetObject(), first::interfaces, m_address, m_peerLinks, m_plugins, and third::mac.

+ Here is the call graph for this function:

◆ IsActiveLink()

bool ns3::dot11s::PeerManagementProtocol::IsActiveLink ( uint32_t  interface,
Mac48Address  peerAddress 
)

Checks if there is established link.

Parameters
interfaceinterface of the link to check
peerAddresspeer address of the link to check
Returns
true if the link is active

Definition at line 356 of file peer-management-protocol.cc.

References FindPeerLink().

+ Here is the call graph for this function:

◆ NotifyBeaconSent()

void ns3::dot11s::PeerManagementProtocol::NotifyBeaconSent ( uint32_t  interface,
Time  beaconInterval 
)

Notify about beacon send event, needed to schedule BCA.

Parameters
interfacethe interface to use
beaconIntervalthe beacon interval

Definition at line 542 of file peer-management-protocol.cc.

References CheckBeaconCollisions(), m_beaconInterval, m_lastBeacon, m_maxBeaconShift, ns3::Simulator::Now(), ns3::Simulator::Schedule(), and TuToTime().

+ Here is the call graph for this function:

◆ NotifyLinkClose()

void ns3::dot11s::PeerManagementProtocol::NotifyLinkClose ( Mac48Address  peerMp,
Mac48Address  peerIface,
Mac48Address  myIface,
uint32_t  interface 
)
private

Aux.

method to register closed links

Parameters
peerMppeer mesh point address
peerIfacepeer address
myIfacemy address
interfaceinterface

Definition at line 483 of file peer-management-protocol.cc.

References ns3::dot11s::PeerManagementProtocol::Statistics::linksClosed, ns3::dot11s::PeerManagementProtocol::Statistics::linksTotal, m_linkCloseTraceSrc, m_peerStatusCallback, m_stats, and NS_LOG_LOGIC.

Referenced by PeerLinkStatus().

+ Here is the caller graph for this function:

◆ NotifyLinkOpen()

void ns3::dot11s::PeerManagementProtocol::NotifyLinkOpen ( Mac48Address  peerMp,
Mac48Address  peerIface,
Mac48Address  myIface,
uint32_t  interface 
)
private

Aux.

method to register open links

Parameters
peerMppeer mesh point address
peerIfacepeer address
myIfacemy address
interfaceinterface

Definition at line 470 of file peer-management-protocol.cc.

References ns3::dot11s::PeerManagementProtocol::Statistics::linksOpened, ns3::dot11s::PeerManagementProtocol::Statistics::linksTotal, m_linkOpenTraceSrc, m_peerStatusCallback, m_stats, and NS_LOG_LOGIC.

Referenced by PeerLinkStatus().

+ Here is the caller graph for this function:

◆ operator=()

PeerManagementProtocol & ns3::dot11s::PeerManagementProtocol::operator= ( const PeerManagementProtocol peer)
private

assignment operator

Parameters
peerthe value to assign
Returns
the assigned value

◆ PeerLinkStatus()

void ns3::dot11s::PeerManagementProtocol::PeerLinkStatus ( uint32_t  interface,
Mac48Address  peerAddress,
Mac48Address  peerMeshPointAddres,
PeerLink::PeerState  ostate,
PeerLink::PeerState  nstate 
)
private

Indicates changes in peer links.

Parameters
interfacethe interface
peerAddressthe peer address
peerMeshPointAddresthe peer mesh point address
ostateold state
nstatenew state

Definition at line 496 of file peer-management-protocol.cc.

References ns3::dot11s::PeerLink::ESTAB, FindPeerLink(), ns3::dot11s::PeerLink::IDLE, m_address, m_plugins, NotifyLinkClose(), NotifyLinkOpen(), NS_ASSERT, NS_LOG_DEBUG, and ns3::dot11s::PeerLink::PeerStateNames.

Referenced by InitiateLink().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ReceiveBeacon()

void ns3::dot11s::PeerManagementProtocol::ReceiveBeacon ( uint32_t  interface,
Mac48Address  peerAddress,
Time  beaconInterval,
Ptr< IeBeaconTiming beaconTiming 
)

To initiate peer link we must notify about received beacon.

Parameters
interfacethe interface where a beacon was received from
peerAddressaddress of station, which sent a beacon
beaconIntervalbeacon interval (needed by beacon loss counter)
beaconTimingbeacon timing element (needed by BCA)

Definition at line 170 of file peer-management-protocol.cc.

References FindPeerLink(), GetBeaconCollisionAvoidance(), ns3::Mac48Address::GetBroadcast(), InitiateLink(), m_plugins, ns3::Simulator::Now(), ns3::PeekPointer(), and ShouldSendOpen().

+ Here is the call graph for this function:

◆ ReceivePeerLinkFrame()

void ns3::dot11s::PeerManagementProtocol::ReceivePeerLinkFrame ( uint32_t  interface,
Mac48Address  peerAddress,
Mac48Address  peerMeshPointAddress,
uint16_t  aid,
IePeerManagement  peerManagementElement,
IeConfiguration  meshConfig 
)

Deliver Peer link management information to the protocol-part.

Parameters
interfaceis a interface ID of a given MAC (interfaceID rather than MAC address, because many interfaces may have the same MAC)
peerAddressis address of peer
peerMeshPointAddressis address of peer mesh point device (equal to peer address when only one interface)
aidis association ID, which peer has assigned to us
peerManagementElementis peer link management element
meshConfigis mesh configuration element taken from the peer management frame

Definition at line 202 of file peer-management-protocol.cc.

References FindPeerLink(), ns3::dot11s::IePeerManagement::GetLocalLinkId(), ns3::dot11s::IePeerManagement::GetPeerLinkId(), ns3::dot11s::IePeerManagement::GetReasonCode(), InitiateLink(), ns3::dot11s::REASON11S_RESERVED, ShouldAcceptOpen(), ns3::dot11s::IePeerManagement::SubtypeIsClose(), ns3::dot11s::IePeerManagement::SubtypeIsConfirm(), and ns3::dot11s::IePeerManagement::SubtypeIsOpen().

+ Here is the call graph for this function:

◆ Report()

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

Report statistics.

Parameters
osthe output stream

Definition at line 561 of file peer-management-protocol.cc.

References m_peerLinks, m_plugins, m_stats, NS_ASSERT, visualizer.base::plugins, and ns3::dot11s::PeerManagementProtocol::Statistics::Print().

+ Here is the call graph for this function:

◆ ResetStats()

void ns3::dot11s::PeerManagementProtocol::ResetStats ( )

◆ SetBeaconCollisionAvoidance()

void ns3::dot11s::PeerManagementProtocol::SetBeaconCollisionAvoidance ( bool  enable)

Enable or disable beacon collision avoidance.

Parameters
enabletrue to enable beacon collision avoidance

Definition at line 608 of file peer-management-protocol.cc.

References m_enableBca.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetMeshId()

void ns3::dot11s::PeerManagementProtocol::SetMeshId ( std::string  s)

Set mesh ID to a string value.

Parameters
sthe mesh ID string value

Definition at line 532 of file peer-management-protocol.cc.

References m_meshId.

◆ SetPeerLinkStatusCallback()

void ns3::dot11s::PeerManagementProtocol::SetPeerLinkStatusCallback ( Callback< void, Mac48Address, Mac48Address, uint32_t, bool >  cb)

Set peer link status change callback.

Parameters
cbthe callback

Definition at line 319 of file peer-management-protocol.cc.

References m_peerStatusCallback.

◆ ShiftOwnBeacon()

void ns3::dot11s::PeerManagementProtocol::ShiftOwnBeacon ( uint32_t  interface)
private

Shift own beacon function.

Parameters
interfaceinterface

Definition at line 444 of file peer-management-protocol.cc.

References ns3::UniformRandomVariable::GetValue(), m_beaconShift, m_plugins, NS_ASSERT, and TuToTime().

Referenced by CheckBeaconCollisions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ShouldAcceptOpen()

bool ns3::dot11s::PeerManagementProtocol::ShouldAcceptOpen ( uint32_t  interface,
Mac48Address  peerAddress,
PmpReasonCode reasonCode 
)
private

External peer-chooser.

Parameters
interfacethe interface to use
peerAddressthe peer address
reasonCodereason code
Returns
true is should send an open

Definition at line 372 of file peer-management-protocol.cc.

References ns3::dot11s::PeerManagementProtocol::Statistics::linksTotal, m_maxNumberOfPeerLinks, m_stats, and ns3::dot11s::REASON11S_MESH_MAX_PEERS.

Referenced by ReceivePeerLinkFrame().

+ Here is the caller graph for this function:

◆ ShouldSendOpen()

bool ns3::dot11s::PeerManagementProtocol::ShouldSendOpen ( uint32_t  interface,
Mac48Address  peerAddress 
)
private

External peer-chooser.

Parameters
interfacethe interface to use
peerAddressthe peer address
Returns
true is should send an open

Definition at line 366 of file peer-management-protocol.cc.

References ns3::dot11s::PeerManagementProtocol::Statistics::linksTotal, m_maxNumberOfPeerLinks, and m_stats.

Referenced by ReceiveBeacon().

+ Here is the caller graph for this function:

◆ TimeToTu()

int ns3::dot11s::PeerManagementProtocol::TimeToTu ( Time  x)
private

Time<-->TU converters:

Parameters
xTime
Returns
TU

Definition at line 464 of file peer-management-protocol.cc.

References sample-rng-plot::x.

Referenced by CheckBeaconCollisions().

+ Here is the caller graph for this function:

◆ TransmissionFailure()

void ns3::dot11s::PeerManagementProtocol::TransmissionFailure ( uint32_t  interface,
const Mac48Address  peerAddress 
)

Cancels peer link due to successive transmission failures.

Parameters
interfaceinterface of the link to cancel
peerAddresspeer address of the link to cancel

Definition at line 250 of file peer-management-protocol.cc.

References FindPeerLink(), GetAddress(), and NS_LOG_DEBUG.

+ Here is the call graph for this function:

◆ TransmissionSuccess()

void ns3::dot11s::PeerManagementProtocol::TransmissionSuccess ( uint32_t  interface,
const Mac48Address  peerAddress 
)

resets transmission failure statistics

Parameters
interfaceinterface of the link to reset
peerAddresspeer address of the link to reset

Definition at line 260 of file peer-management-protocol.cc.

References FindPeerLink(), GetAddress(), and NS_LOG_DEBUG.

+ Here is the call graph for this function:

◆ TuToTime()

Time ns3::dot11s::PeerManagementProtocol::TuToTime ( int  x)
private

Time<-->TU converters:

Parameters
xTU
Returns
Time

Definition at line 459 of file peer-management-protocol.cc.

References ns3::MicroSeconds(), and sample-rng-plot::x.

Referenced by CheckBeaconCollisions(), NotifyBeaconSent(), and ShiftOwnBeacon().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_address

Mac48Address ns3::dot11s::PeerManagementProtocol::m_address
private

address

Definition at line 346 of file peer-management-protocol.h.

Referenced by GetAddress(), Install(), and PeerLinkStatus().

◆ m_beaconInterval

std::map<uint32_t, Time> ns3::dot11s::PeerManagementProtocol::m_beaconInterval
private

Beacon interval at each interface.

Definition at line 359 of file peer-management-protocol.h.

Referenced by CheckBeaconCollisions(), and NotifyBeaconSent().

◆ m_beaconShift

Ptr<UniformRandomVariable> ns3::dot11s::PeerManagementProtocol::m_beaconShift
private

Add randomness to beacon shift.

Definition at line 402 of file peer-management-protocol.h.

Referenced by PeerManagementProtocol(), AssignStreams(), DoInitialize(), and ShiftOwnBeacon().

◆ m_enableBca

bool ns3::dot11s::PeerManagementProtocol::m_enableBca
private

Flag which enables BCA.

Definition at line 353 of file peer-management-protocol.h.

Referenced by GetBeaconCollisionAvoidance(), and SetBeaconCollisionAvoidance().

◆ m_lastAssocId

uint16_t ns3::dot11s::PeerManagementProtocol::m_lastAssocId
private

last associated ID

Definition at line 349 of file peer-management-protocol.h.

Referenced by InitiateLink().

◆ m_lastBeacon

std::map<uint32_t, Time> ns3::dot11s::PeerManagementProtocol::m_lastBeacon
private

Last beacon at each interface.

Definition at line 357 of file peer-management-protocol.h.

Referenced by CheckBeaconCollisions(), and NotifyBeaconSent().

◆ m_lastLocalLinkId

uint16_t ns3::dot11s::PeerManagementProtocol::m_lastLocalLinkId
private

last local link ID

Definition at line 350 of file peer-management-protocol.h.

Referenced by InitiateLink().

◆ m_linkCloseTraceSrc

LinkEventCallback ns3::dot11s::PeerManagementProtocol::m_linkCloseTraceSrc
private

LinkClose trace source.

Definition at line 379 of file peer-management-protocol.h.

Referenced by GetTypeId(), and NotifyLinkClose().

◆ m_linkOpenTraceSrc

LinkEventCallback ns3::dot11s::PeerManagementProtocol::m_linkOpenTraceSrc
private

LinkOpen trace source.

Definition at line 377 of file peer-management-protocol.h.

Referenced by GetTypeId(), and NotifyLinkOpen().

◆ m_maxBeaconShift

uint16_t ns3::dot11s::PeerManagementProtocol::m_maxBeaconShift
private

Beacon can be shifted at [-m_maxBeaconShift; +m_maxBeaconShift] TUs.

Definition at line 355 of file peer-management-protocol.h.

Referenced by CheckBeaconCollisions(), DoInitialize(), GetTypeId(), and NotifyBeaconSent().

◆ m_maxNumberOfPeerLinks

uint8_t ns3::dot11s::PeerManagementProtocol::m_maxNumberOfPeerLinks
private

maimum number of peer links

Definition at line 351 of file peer-management-protocol.h.

Referenced by GetTypeId(), ShouldAcceptOpen(), and ShouldSendOpen().

◆ m_meshId

Ptr<IeMeshId> ns3::dot11s::PeerManagementProtocol::m_meshId
private

mesh ID

Definition at line 347 of file peer-management-protocol.h.

Referenced by ~PeerManagementProtocol(), GetMeshId(), and SetMeshId().

◆ m_peerLinks

PeerLinksMap ns3::dot11s::PeerManagementProtocol::m_peerLinks
private

Simple link open/close trace source type. Addresses are: src interface, dst interface.

Definition at line 364 of file peer-management-protocol.h.

Referenced by CheckBeaconCollisions(), DoDispose(), FindPeerLink(), GetBeaconTimingElement(), GetPeerLinks(), GetPeers(), InitiateLink(), Install(), and Report().

◆ m_peerStatusCallback

Callback<void, Mac48Address, Mac48Address, uint32_t, bool> ns3::dot11s::PeerManagementProtocol::m_peerStatusCallback
private

Callback to notify about peer link changes: Mac48Address is peer address of mesh point, Mac48Address is peer address of interface, uint32_t - interface ID, bool is status - true when new link has appeared, false - when link was closed,.

Definition at line 372 of file peer-management-protocol.h.

Referenced by NotifyLinkClose(), NotifyLinkOpen(), and SetPeerLinkStatusCallback().

◆ m_plugins

PeerManagementProtocolMacMap ns3::dot11s::PeerManagementProtocol::m_plugins
private

◆ m_stats

struct Statistics ns3::dot11s::PeerManagementProtocol::m_stats
private

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