802.11s Peer link close management frame More...

#include "peer-link-frame.h"

Inheritance diagram for ns3::dot11s::PeerLinkCloseStart:

Classes
struct	PlinkCloseStartFields
	fields: More...

Public Member Functions
	PeerLinkCloseStart ()

virtual uint32_t	Deserialize (Buffer::Iterator start)

PlinkCloseStartFields	GetFields () const
	Get peer link close start fields. More...

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

virtual uint32_t	GetSerializedSize () const

virtual void	Print (std::ostream &os) const

virtual void	Serialize (Buffer::Iterator start) const

void	SetPlinkCloseStart (PlinkCloseStartFields fields)
	Set peer link close start fields. More...

Public Member Functions inherited from ns3::Header
virtual	~Header ()

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. 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...

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::Header
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

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

Private Member Functions
	PeerLinkCloseStart (const PeerLinkCloseStart &)
	type conversion operator More...

PeerLinkCloseStart &	operator= (const PeerLinkCloseStart &peer)
	assignment operator More...

Private Attributes
IeMeshId	m_meshId
	mesh ID More...

Friends
bool	operator== (const PeerLinkCloseStart &a, const PeerLinkCloseStart &b)
	equality operator More...

Additional Inherited Members
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...

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

Detailed Description

802.11s Peer link close management frame

Introspection did not find any typical Config paths.

Peer link close frame includes the following:

Mesh ID of mesh

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 119 of file peer-link-frame.h.

Constructor & Destructor Documentation

◆ PeerLinkCloseStart() [1/2]

ns3::dot11s::PeerLinkCloseStart::PeerLinkCloseStart ( )

Definition at line 138 of file peer-link-frame.cc.

◆ PeerLinkCloseStart() [2/2]

ns3::dot11s::PeerLinkCloseStart::PeerLinkCloseStart ( const PeerLinkCloseStart & )

private

type conversion operator

Member Function Documentation

◆ Deserialize()

uint32_t ns3::dot11s::PeerLinkCloseStart::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 190 of file peer-link-frame.cc.

References ns3::dot11s::IeMeshId::DeserializeInformationField(), ns3::dot11s::IeMeshId::ElementId(), ns3::Buffer::Iterator::GetDistanceFrom(), ns3::dot11s::IeMeshId::GetInformationFieldSize(), m_meshId, ns3::Buffer::Iterator::Next(), NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

◆ GetFields()

PeerLinkCloseStart::PlinkCloseStartFields ns3::dot11s::PeerLinkCloseStart::GetFields ( ) const

Get peer link close start fields.

Returns: PlinkOpenStartFields

Todo:: protocol version:

Definition at line 148 of file peer-link-frame.cc.

References m_meshId, and ns3::dot11s::PeerLinkCloseStart::PlinkCloseStartFields::meshId.

Referenced by ns3::dot11s::PeerManagementProtocolMac::Receive().

◆ GetInstanceTypeId()

TypeId ns3::dot11s::PeerLinkCloseStart::GetInstanceTypeId ( ) const

virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 167 of file peer-link-frame.cc.

References GetTypeId().

◆ GetSerializedSize()

uint32_t ns3::dot11s::PeerLinkCloseStart::GetSerializedSize ( ) const

virtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 177 of file peer-link-frame.cc.

References ns3::dot11s::IeMeshId::GetInformationFieldSize(), and m_meshId.

◆ GetTypeId()

TypeId ns3::dot11s::PeerLinkCloseStart::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 157 of file peer-link-frame.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

◆ operator=()

PeerLinkCloseStart& ns3::dot11s::PeerLinkCloseStart::operator= ( const PeerLinkCloseStart & peer )

private

assignment operator

Parameters

peer	the value to assign

Returns: the assigned value

◆ Print()

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

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 172 of file peer-link-frame.cc.

References m_meshId, and ns3::dot11s::IeMeshId::Print().

◆ Serialize()

void ns3::dot11s::PeerLinkCloseStart::Serialize ( Buffer::Iterator start ) const

virtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 184 of file peer-link-frame.cc.

References m_meshId, ns3::WifiInformationElement::Serialize(), and visualizer.core::start().

◆ SetPlinkCloseStart()

void ns3::dot11s::PeerLinkCloseStart::SetPlinkCloseStart ( PeerLinkCloseStart::PlinkCloseStartFields fields )

Set peer link close start fields.

Parameters

fields PlinkCloseStartFields to set

Definition at line 143 of file peer-link-frame.cc.

References m_meshId, and ns3::dot11s::PeerLinkCloseStart::PlinkCloseStartFields::meshId.

Referenced by PeerLinkFrameStartTest::DoRun(), and ns3::dot11s::PeerManagementProtocolMac::SendPeerLinkManagementFrame().

Friends And Related Function Documentation

◆ operator==

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

friend

equality operator

Parameters

a	lhs
b	rhs

Returns: true if equal

Definition at line 205 of file peer-link-frame.cc.

Member Data Documentation

◆ m_meshId

IeMeshId ns3::dot11s::PeerLinkCloseStart::m_meshId

private

mesh ID

Definition at line 153 of file peer-link-frame.h.

Referenced by Deserialize(), GetFields(), GetSerializedSize(), ns3::dot11s::operator==(), Print(), Serialize(), and SetPlinkCloseStart().

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

src/mesh/model/dot11s/peer-link-frame.h
src/mesh/model/dot11s/peer-link-frame.cc

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeerLinkCloseStart() [1/2]

◆ PeerLinkCloseStart() [2/2]

Member Function Documentation

◆ Deserialize()

◆ GetFields()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ operator=()

◆ Print()

◆ Serialize()

◆ SetPlinkCloseStart()

Friends And Related Function Documentation

◆ operator==

Member Data Documentation

◆ m_meshId