ns-3
ns3::dot11s::PeerLink Class Reference

Peer link model for 802.11s Peer Management protocol. More...

#include <peer-link.h>

Inheritance diagram for ns3::dot11s::PeerLink:
Collaboration diagram for ns3::dot11s::PeerLink:

List of all members.

Public Types

enum  PeerState {
  IDLE, OPN_SNT, CNF_RCVD, OPN_RCVD,
  ESTAB, HOLDING
}
 Peer Link state:

Public Member Functions

 PeerLink ()
 C-tor create empty link.
void DoDispose ()
void SetBeaconInformation (Time lastBeacon, Time BeaconInterval)
 Process beacon received from peer.
void SetLinkStatusCallback (Callback< void, uint32_t, Mac48Address, bool > cb)
 Method used to detect peer link changes.
void Report (std::ostream &os) const
 Statistics.
Peer link getters/setters
void SetPeerAddress (Mac48Address macaddr)
void SetPeerMeshPointAddress (Mac48Address macaddr)
void SetInterface (uint32_t interface)
void SetLocalLinkId (uint16_t id)
void SetLocalAid (uint16_t aid)
uint16_t GetPeerAid () const
void SetBeaconTimingElement (IeBeaconTiming beaconTiming)
Mac48Address GetPeerAddress () const
uint16_t GetLocalAid () const
Time GetLastBeacon () const
Time GetBeaconInterval () const
IeBeaconTiming GetBeaconTimingElement () const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId ()
 Support object system.

Friends

class PeerManagementProtocol

MLME

typedef Callback< void,
uint32_t, Mac48Address,
Mac48Address,
PeerLink::PeerState,
PeerLink::PeerState
SignalStatusCallback
 Callback type for MLME-SignalPeerLinkStatus event.
void MLMECancelPeerLink (PmpReasonCode reason)
 MLME-CancelPeerLink.request.
void MLMEActivePeerLinkOpen ()
 MLME-ActivePeerLinkOpen.request.
void MLMEPeeringRequestReject ()
 MLME-PeeringRequestReject.
void MLMESetSignalStatusCallback (SignalStatusCallback)
 Set callback.
void TransmissionSuccess ()
 Reports about transmission success/failure.
void TransmissionFailure ()

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
 Object (const Object &o)

Detailed Description

Peer link model for 802.11s Peer Management protocol.


Member Function Documentation

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

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

Subclasses are expected to implement their real destruction code in an overriden 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.

References ns3::EventId::Cancel().

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

Support object system.

This method returns the TypeId associated to ns3::dot11s::PeerLink.

Attributes defined for this type:

  • RetryTimeout: Retry timeout
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +40960000.0ns
    • Flags: construct write read
  • HoldingTimeout: Holding timeout
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +40960000.0ns
    • Flags: construct write read
  • ConfirmTimeout: Confirm timeout
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +40960000.0ns
    • Flags: construct write read
  • MaxRetries: Maximum number of retries
  • MaxBeaconLoss: Maximum number of lost beacons before link will be closed
  • MaxPacketFailure: Maximum number of failed packets before link will be closed

No TraceSources defined for this type.

Reimplemented from ns3::Object.

References ns3::MicroSeconds(), and ns3::TypeId::SetParent().

void ns3::dot11s::PeerLink::SetLinkStatusCallback ( Callback< void, uint32_t, Mac48Address, bool >  cb)

Method used to detect peer link changes.

Parameters:
cbis a callback, which notifies, that on interface (uint32_t), peer link with address (Mac48Address) was opened (bool is true) or closed (bool is false)

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