A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::dot11s::IePeerManagement Class Reference

See 7.3.2.85 of draft 2.07. More...

#include <ie-dot11s-peer-management.h>

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

Public Types

enum  Subtype { PEER_OPEN = 0, PEER_CONFIRM, PEER_CLOSE }
 

Public Member Functions

 IePeerManagement ()
 
uint16_t GetLocalLinkId () const
 
uint16_t GetPeerLinkId () const
 
PmpReasonCode GetReasonCode () const
 
uint8_t GetSubtype () const
 
void SetPeerClose (uint16_t localLinkID, uint16_t peerLinkId, PmpReasonCode reasonCode)
 
void SetPeerConfirm (uint16_t localLinkID, uint16_t peerLinkId)
 
void SetPeerOpen (uint16_t localLinkId)
 
bool SubtypeIsClose () const
 
bool SubtypeIsConfirm () const
 
bool SubtypeIsOpen () const
 
Inherited from WifiInformationElement
virtual WifiInformationElementId ElementId () const
 Own unique Element ID. More...
 
virtual uint8_t GetInformationFieldSize (void) const
 Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...
 
virtual void SerializeInformationField (Buffer::Iterator i) const
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual uint8_t DeserializeInformationField (Buffer::Iterator i, uint8_t length)
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual void Print (std::ostream &os) const
 In addition, a subclass may optionally override the following... More...
 
- Public Member Functions inherited from ns3::WifiInformationElement
virtual ~WifiInformationElement ()
 
Buffer::Iterator Deserialize (Buffer::Iterator i)
 Deserialize entire IE, which must be present. More...
 
Buffer::Iterator DeserializeIfPresent (Buffer::Iterator i)
 Deserialize entire IE if it is present. More...
 
uint16_t GetSerializedSize () const
 Get the size of the serialized IE including Element ID and length fields. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual bool operator< (WifiInformationElement const &a) const
 Compare information elements using Element ID. More...
 
virtual bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
 SimpleRefCount ()
 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. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

uint8_t m_length
 
uint16_t m_localLinkId
 
uint16_t m_peerLinkId
 Present within confirm and may be present in close. More...
 
PmpReasonCode m_reasonCode
 Present only within close frame. More...
 
uint8_t m_subtype
 

Friends

bool operator== (const IePeerManagement &a, const IePeerManagement &b)
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

See 7.3.2.85 of draft 2.07.

Definition at line 52 of file ie-dot11s-peer-management.h.

Member Enumeration Documentation

Enumerator
PEER_OPEN 
PEER_CONFIRM 
PEER_CLOSE 

Definition at line 56 of file ie-dot11s-peer-management.h.

Constructor & Destructor Documentation

ns3::dot11s::IePeerManagement::IePeerManagement ( )

Definition at line 29 of file ie-dot11s-peer-management.cc.

Member Function Documentation

uint8_t ns3::dot11s::IePeerManagement::DeserializeInformationField ( Buffer::Iterator  start,
uint8_t  length 
)
virtual

Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters
startan iterator which points to where the information should be written.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 123 of file ie-dot11s-peer-management.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_length, m_localLinkId, m_peerLinkId, m_reasonCode, m_subtype, NS_ASSERT, PEER_CLOSE, PEER_CONFIRM, PEER_OPEN, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

WifiInformationElementId ns3::dot11s::IePeerManagement::ElementId ( ) const
virtual

Own unique Element ID.

Implements ns3::WifiInformationElement.

Definition at line 34 of file ie-dot11s-peer-management.cc.

References IE11S_PEERING_MANAGEMENT.

Referenced by Print().

+ Here is the caller graph for this function:

uint8_t ns3::dot11s::IePeerManagement::GetInformationFieldSize ( void  ) const
virtual

Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.

This is the value that will appear in the second octet of the entire IE - the length field)

Returns
the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 83 of file ie-dot11s-peer-management.cc.

References m_length.

uint16_t ns3::dot11s::IePeerManagement::GetLocalLinkId ( ) const

Definition at line 71 of file ie-dot11s-peer-management.cc.

References m_localLinkId.

Referenced by ns3::dot11s::PeerManagementProtocol::ReceivePeerLinkFrame().

+ Here is the caller graph for this function:

uint16_t ns3::dot11s::IePeerManagement::GetPeerLinkId ( ) const

Definition at line 77 of file ie-dot11s-peer-management.cc.

References m_peerLinkId.

Referenced by ns3::dot11s::PeerManagementProtocol::ReceivePeerLinkFrame().

+ Here is the caller graph for this function:

PmpReasonCode ns3::dot11s::IePeerManagement::GetReasonCode ( ) const
uint8_t ns3::dot11s::IePeerManagement::GetSubtype ( ) const

Definition at line 88 of file ie-dot11s-peer-management.cc.

References m_subtype.

void ns3::dot11s::IePeerManagement::Print ( std::ostream &  os) const
virtual

In addition, a subclass may optionally override the following...

Generate human-readable form of IE

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 152 of file ie-dot11s-peer-management.cc.

References ElementId(), m_length, m_localLinkId, m_peerLinkId, m_reasonCode, and m_subtype.

Referenced by ns3::dot11s::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dot11s::IePeerManagement::SerializeInformationField ( Buffer::Iterator  start) const
virtual

Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 109 of file ie-dot11s-peer-management.cc.

References m_length, m_localLinkId, m_peerLinkId, m_reasonCode, m_subtype, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::dot11s::IePeerManagement::SetPeerClose ( uint16_t  localLinkID,
uint16_t  peerLinkId,
PmpReasonCode  reasonCode 
)

Definition at line 46 of file ie-dot11s-peer-management.cc.

References m_length, m_localLinkId, m_peerLinkId, m_reasonCode, m_subtype, and PEER_CLOSE.

Referenced by ns3::dot11s::PeerLink::SendPeerLinkClose().

+ Here is the caller graph for this function:

void ns3::dot11s::IePeerManagement::SetPeerConfirm ( uint16_t  localLinkID,
uint16_t  peerLinkId 
)

Definition at line 56 of file ie-dot11s-peer-management.cc.

References m_length, m_localLinkId, m_peerLinkId, m_subtype, and PEER_CONFIRM.

Referenced by ns3::dot11s::PeerLink::SendPeerLinkConfirm().

+ Here is the caller graph for this function:

void ns3::dot11s::IePeerManagement::SetPeerOpen ( uint16_t  localLinkId)

Definition at line 39 of file ie-dot11s-peer-management.cc.

References m_length, m_localLinkId, m_subtype, and PEER_OPEN.

Referenced by ns3::dot11s::PeerLink::SendPeerLinkOpen().

+ Here is the caller graph for this function:

bool ns3::dot11s::IePeerManagement::SubtypeIsClose ( ) const
bool ns3::dot11s::IePeerManagement::SubtypeIsConfirm ( ) const
bool ns3::dot11s::IePeerManagement::SubtypeIsOpen ( ) const

Friends And Related Function Documentation

bool operator== ( const IePeerManagement a,
const IePeerManagement b 
)
friend

Definition at line 163 of file ie-dot11s-peer-management.cc.

Member Data Documentation

uint16_t ns3::dot11s::IePeerManagement::m_localLinkId
private
uint16_t ns3::dot11s::IePeerManagement::m_peerLinkId
private

Present within confirm and may be present in close.

Definition at line 90 of file ie-dot11s-peer-management.h.

Referenced by DeserializeInformationField(), GetPeerLinkId(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), SetPeerClose(), and SetPeerConfirm().

PmpReasonCode ns3::dot11s::IePeerManagement::m_reasonCode
private

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