ns3::dot11s::PeerLink Class Reference [IEEE 802.11s draft]

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

---

Detailed Description

Peer link model for 802.11s Peer Management protocol.

---

Member Function Documentation

void ns3::dot11s::PeerLink::DoDispose

(

)

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

static TypeId ns3::dot11s::PeerLink::GetTypeId

(

void

)

[static]

Support object system.

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

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::dot11s::PeerLink
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::dot11s::PeerLink

Attributes defined for this type:

• RetryTimeout: Retry timeout
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 40960000ns
  • Flags: construct write read
• HoldingTimeout: Holding timeout
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 40960000ns
  • Flags: construct write read
• ConfirmTimeout: Confirm timeout
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 40960000ns
  • Flags: construct write read
• MaxRetries: Maximum number of retries
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 0:65535
  • Initial value: 4
  • Flags: construct write read
• MaxBeaconLoss: Maximum number of lost beacons before link will be closed
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 1:65535
  • Initial value: 2
  • Flags: construct write read
• MaxPacketFailure: Maximum number of failed packets before link will be closed
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 1:65535
  • Initial value: 2
  • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Object.

void ns3::dot11s::PeerLink::SetLinkStatusCallback

(

Callback< void, uint32_t, Mac48Address, bool >

cb

)

Method used to detect peer link changes.

Parameters:

cb

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

• src/devices/mesh/dot11s/peer-link.h
• doc/introspected-doxygen.h