6LoWPAN Mesh header - see RFC 4944. More...

#include "sixlowpan-header.h"

Inheritance diagram for ns3::SixLowPanMesh:

Collaboration diagram for ns3::SixLowPanMesh:

Public Member Functions
	SixLowPanMesh ()

uint32_t	Deserialize (Buffer::Iterator start) override
	Deserialize the packet.

Address	GetFinalDst () const
	Get the "Final Destination" address.

uint8_t	GetHopsLeft () const
	Get the "Hops Left" field.

TypeId	GetInstanceTypeId () const override
	Return the instance type identifier.

Address	GetOriginator () const
	Get the "Originator" address.

uint32_t	GetSerializedSize () const override
	Get the serialized size of the packet.

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

void	Serialize (Buffer::Iterator start) const override
	Serialize the packet.

void	SetFinalDst (Address finalDst)
	Set the "Final Destination" address.

void	SetHopsLeft (uint8_t hopsLeft)
	Set the "Hops Left" field.

void	SetOriginator (Address originator)
	Set the "Originator" address.

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

uint32_t	Deserialize (Buffer::Iterator start) override=0

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

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

virtual uint32_t	GetSerializedSize () const =0

void	Print (std::ostream &os) const override=0

virtual void	Serialize (Buffer::Iterator start) const =0

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

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

virtual void	Print (std::ostream &os) const =0
	Print the object contents.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

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

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

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

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

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

Private Attributes
Address	m_dst
	Destination (final) address.

bool	m_f
	True if Destination address is 16 bit.

uint8_t	m_hopsLeft
	Hops left.

Address	m_src
	Originator (source) address.

bool	m_v
	True if Originator address is 16 bit.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

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

Detailed Description

6LoWPAN Mesh header - see RFC 4944.

Definition at line 1295 of file sixlowpan-header.h.

Constructor & Destructor Documentation

◆ SixLowPanMesh()

ns3::SixLowPanMesh::SixLowPanMesh ( )

Definition at line 1955 of file sixlowpan-header.cc.

References m_dst, m_f, m_hopsLeft, m_src, and m_v.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::SixLowPanMesh::Deserialize ( Buffer::Iterator start )

overridevirtual

Deserialize the packet.

Parameters

[in] start Buffer iterator.

Returns: Size of the packet.

Implements ns3::Header.

Definition at line 2086 of file sixlowpan-header.cc.

References ns3::Address::CopyFrom(), GetSerializedSize(), m_dst, m_f, m_hopsLeft, m_src, m_v, ns3::Buffer::Iterator::Read(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetFinalDst()

Address ns3::SixLowPanMesh::GetFinalDst ( ) const

Get the "Final Destination" address.

Returns: The Final Destination address (Mac64Address or Mac16Address).

Definition at line 2178 of file sixlowpan-header.cc.

References m_dst.

Referenced by ns3::SixLowPanNetDevice::ReceiveFromDevice().

Here is the caller graph for this function:

◆ GetHopsLeft()

uint8_t ns3::SixLowPanMesh::GetHopsLeft ( ) const

Get the "Hops Left" field.

Returns: The number of hops left.

Definition at line 2190 of file sixlowpan-header.cc.

References m_hopsLeft.

Referenced by ns3::SixLowPanNetDevice::ReceiveFromDevice().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SixLowPanMesh::GetInstanceTypeId ( ) const

overridevirtual

Return the instance type identifier.

Returns: Instance type ID.

Implements ns3::ObjectBase.

Definition at line 1975 of file sixlowpan-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetOriginator()

Address ns3::SixLowPanMesh::GetOriginator ( ) const

Get the "Originator" address.

Returns: The Originator address (Mac64Address or Mac16Address).

Definition at line 2153 of file sixlowpan-header.cc.

References m_src.

Referenced by ns3::SixLowPanNetDevice::ReceiveFromDevice().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::SixLowPanMesh::GetSerializedSize ( ) const

overridevirtual

Get the serialized size of the packet.

Returns: Size.

Implements ns3::Header.

Definition at line 2004 of file sixlowpan-header.cc.

References m_f, m_hopsLeft, and m_v.

Referenced by Deserialize(), and ns3::SixLowPanNetDevice::DoSend().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SixLowPanMesh::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 1965 of file sixlowpan-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::SixLowPanMesh::Print ( std::ostream & os ) const

overridevirtual

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 1981 of file sixlowpan-header.cc.

References ns3::Mac16Address::ConvertFrom(), ns3::Mac64Address::ConvertFrom(), ns3::Mac64Address::IsMatchingType(), m_dst, m_hopsLeft, and m_src.

Referenced by ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

void ns3::SixLowPanMesh::Serialize ( Buffer::Iterator start ) const

overridevirtual

Serialize the packet.

Parameters

[in] start Buffer iterator.

Implements ns3::Header.

Definition at line 2035 of file sixlowpan-header.cc.

References ns3::Address::CopyTo(), m_dst, m_f, m_hopsLeft, m_src, m_v, ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetFinalDst()

void ns3::SixLowPanMesh::SetFinalDst ( Address finalDst )

Set the "Final Destination" address.

Parameters

[in] finalDst The Final Destination address (Mac64Address or Mac16Address).

Definition at line 2159 of file sixlowpan-header.cc.

References ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), m_dst, m_f, and NS_ABORT_MSG.

Referenced by ns3::SixLowPanNetDevice::DoSend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHopsLeft()

void ns3::SixLowPanMesh::SetHopsLeft ( uint8_t hopsLeft )

Set the "Hops Left" field.

Parameters

[in] hopsLeft The number of hops left.

Definition at line 2184 of file sixlowpan-header.cc.

References m_hopsLeft.

Referenced by ns3::SixLowPanNetDevice::DoSend(), and ns3::SixLowPanNetDevice::ReceiveFromDevice().

Here is the caller graph for this function:

◆ SetOriginator()

void ns3::SixLowPanMesh::SetOriginator ( Address originator )

Set the "Originator" address.

Parameters

[in] originator The Originator address (Mac64Address or Mac16Address).

Definition at line 2134 of file sixlowpan-header.cc.

References ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), m_src, m_v, and NS_ABORT_MSG.

Referenced by ns3::SixLowPanNetDevice::DoSend().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_dst

Address ns3::SixLowPanMesh::m_dst

private

Destination (final) address.

Definition at line 1374 of file sixlowpan-header.h.

Referenced by SixLowPanMesh(), Deserialize(), GetFinalDst(), Print(), Serialize(), and SetFinalDst().

◆ m_f

bool ns3::SixLowPanMesh::m_f

private

True if Destination address is 16 bit.

Definition at line 1372 of file sixlowpan-header.h.

Referenced by SixLowPanMesh(), Deserialize(), GetSerializedSize(), Serialize(), and SetFinalDst().

◆ m_hopsLeft

uint8_t ns3::SixLowPanMesh::m_hopsLeft

private

Hops left.

Definition at line 1370 of file sixlowpan-header.h.

Referenced by SixLowPanMesh(), Deserialize(), GetHopsLeft(), GetSerializedSize(), Print(), Serialize(), and SetHopsLeft().

◆ m_src

Address ns3::SixLowPanMesh::m_src

private

Originator (source) address.

Definition at line 1373 of file sixlowpan-header.h.

Referenced by SixLowPanMesh(), Deserialize(), GetOriginator(), Print(), Serialize(), and SetOriginator().

◆ m_v

bool ns3::SixLowPanMesh::m_v

private

True if Originator address is 16 bit.

Definition at line 1371 of file sixlowpan-header.h.

Referenced by SixLowPanMesh(), Deserialize(), GetSerializedSize(), Serialize(), and SetOriginator().

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

src/sixlowpan/model/sixlowpan-header.h
src/sixlowpan/model/sixlowpan-header.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SixLowPanMesh()

Member Function Documentation

◆ Deserialize()

◆ GetFinalDst()

◆ GetHopsLeft()

◆ GetInstanceTypeId()

◆ GetOriginator()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetFinalDst()

◆ SetHopsLeft()

◆ SetOriginator()

Member Data Documentation

◆ m_dst

◆ m_f

◆ m_hopsLeft

◆ m_src

◆ m_v