A Discrete-Event Network Simulator
API
ns3::SixLowPanMesh Class Reference

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 (void)
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet. More...
 
Address GetFinalDst (void) const
 Get the "Final Destination" address. More...
 
uint8_t GetHopsLeft (void) const
 Get the "Hops Left" field. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Return the instance type identifier. More...
 
Address GetOriginator (void) const
 Get the "Originator" address. More...
 
virtual uint32_t GetSerializedSize (void) const
 Get the serialized size of the packet. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet. More...
 
void SetFinalDst (Address finalDst)
 Set the "Final Destination" address. More...
 
void SetHopsLeft (uint8_t hopsLeft)
 Set the "Hops Left" field. More...
 
void SetOriginator (Address originator)
 Set the "Originator" address. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 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 (void)
 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 Attributes

Address m_dst
 Destination (final) address. More...
 
bool m_f
 True if Destination address is 16 bit. More...
 
uint8_t m_hopsLeft
 Hops left. More...
 
Address m_src
 Originator (source) address. More...
 
bool m_v
 True if Originator address is 16 bit. 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...
 

Detailed Description

6LoWPAN Mesh header - see RFC 4944.

Introspection did not find any typical Config paths.


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 1301 of file sixlowpan-header.h.

Constructor & Destructor Documentation

◆ SixLowPanMesh()

ns3::SixLowPanMesh::SixLowPanMesh ( void  )

Definition at line 1834 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)
virtual

Deserialize the packet.

Parameters
[in]startBuffer iterator.
Returns
Size of the packet.

Implements ns3::Header.

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

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

+ Here is the call graph for this function:

◆ GetFinalDst()

Address ns3::SixLowPanMesh::GetFinalDst ( void  ) const

Get the "Final Destination" address.

Returns
The Final Destination address (Mac64Address or Mac16Address).

Definition at line 2047 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 ( void  ) const

Get the "Hops Left" field.

Returns
The number of hops left.

Definition at line 2057 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 ( void  ) const
virtual

Return the instance type identifier.

Returns
Instance type ID.

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetOriginator()

Address ns3::SixLowPanMesh::GetOriginator ( void  ) const

Get the "Originator" address.

Returns
The Originator address (Mac64Address or Mac16Address).

Definition at line 2024 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 ( void  ) const
virtual

Get the serialized size of the packet.

Returns
Size.

Implements ns3::Header.

Definition at line 1879 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 ( void  )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 1843 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
virtual
Parameters
osoutput 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 1857 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
virtual

Serialize the packet.

Parameters
[in]startBuffer iterator.

Implements ns3::Header.

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

References ns3::Address::CopyTo(), m_dst, m_f, m_hopsLeft, m_src, m_v, visualizer.core::start(), 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]finalDstThe Final Destination address (Mac64Address or Mac16Address).

Definition at line 2029 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]hopsLeftThe number of hops left.

Definition at line 2052 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]originatorThe Originator address (Mac64Address or Mac16Address).

Definition at line 2006 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 1380 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 1378 of file sixlowpan-header.h.

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

◆ m_hopsLeft

uint8_t ns3::SixLowPanMesh::m_hopsLeft
private

◆ m_src

Address ns3::SixLowPanMesh::m_src
private

Originator (source) address.

Definition at line 1379 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 1377 of file sixlowpan-header.h.

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


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