This header can store HELP, TC, MID and HNA messages. More...

#include "olsr-header.h"

Inheritance diagram for ns3::olsr::MessageHeader:

Classes
struct	Hello
	HELLO Message Format More...

struct	Hna
	HNA (Host Network Association) Message Format More...

struct	Mid
	MID Message Format More...

struct	Tc
	TC Message Format More...

Public Types
enum	MessageType { HELLO_MESSAGE = 1, TC_MESSAGE = 2, MID_MESSAGE = 3, HNA_MESSAGE = 4 }
	Message type. More...

Public Member Functions
	MessageHeader ()

virtual	~MessageHeader ()

virtual uint32_t	Deserialize (Buffer::Iterator start)

Hello &	GetHello ()
	Set the message type to HELLO and return the message content. More...

const Hello &	GetHello () const
	Get the HELLO message. More...

Hna &	GetHna ()
	Set the message type to HNA and return the message content. More...

const Hna &	GetHna () const
	Get the HNA message. More...

uint8_t	GetHopCount () const
	Get the hop count. More...

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

uint16_t	GetMessageSequenceNumber () const
	Get the message sequence number. More...

MessageType	GetMessageType () const
	Get the message type. More...

Mid &	GetMid ()
	Set the message type to MID and return the message content. More...

const Mid &	GetMid () const
	Get the MID message. More...

Ipv4Address	GetOriginatorAddress () const
	Get the originator address. More...

virtual uint32_t	GetSerializedSize (void) const

Tc &	GetTc ()
	Set the message type to TC and return the message content. More...

const Tc &	GetTc () const
	Get the TC message. More...

uint8_t	GetTimeToLive () const
	Get the time to live. More...

Time	GetVTime () const
	Get the validity time. More...

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetHopCount (uint8_t hopCount)
	Set the hop count. More...

void	SetMessageSequenceNumber (uint16_t messageSequenceNumber)
	Set the message sequence number. More...

void	SetMessageType (MessageType messageType)
	Set the message type. More...

void	SetOriginatorAddress (Ipv4Address originatorAddress)
	Set the originator address. More...

void	SetTimeToLive (uint8_t timeToLive)
	Set the time to live. More...

void	SetVTime (Time time)
	Set the validity time. 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 (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
uint8_t	m_hopCount
	The hop count. More...

struct {
Hello hello
	HELLO message (optional). More...

Hna hna
	HNA message (optional). More...

Mid mid
	MID message (optional). More...

Tc tc
	TC message (optional). More...

}	m_message
	Structure holding the message content. More...

uint16_t	m_messageSequenceNumber
	The message sequence number. More...

uint16_t	m_messageSize
	The message size. More...

MessageType	m_messageType
	The message type. More...

Ipv4Address	m_originatorAddress
	The originator address. More...

uint8_t	m_timeToLive
	The time to live. More...

uint8_t	m_vTime
	The validity time. 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

This header can store HELP, TC, MID and HNA messages.

Introspection did not find any typical Config paths.

The header size is variable, and depends on the actual message type.

  0                   1                   2                   3
  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Message Type |     Vtime     |         Message Size          |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                      Originator Address                       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Time To Live |   Hop Count   |    Message Sequence Number    |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               |
 :                            MESSAGE                            :
 |                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

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

Definition at line 157 of file olsr-header.h.

Member Enumeration Documentation

◆ MessageType

enum ns3::olsr::MessageHeader::MessageType

Message type.

Enumerator
HELLO_MESSAGE
TC_MESSAGE
MID_MESSAGE
HNA_MESSAGE

Definition at line 163 of file olsr-header.h.

Constructor & Destructor Documentation

◆ MessageHeader()

ns3::olsr::MessageHeader::MessageHeader ( )

Definition at line 163 of file olsr-header.cc.

◆ ~MessageHeader()

ns3::olsr::MessageHeader::~MessageHeader ( )

virtual

Definition at line 168 of file olsr-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::olsr::MessageHeader::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 252 of file olsr-header.cc.

References HELLO_MESSAGE, HNA_MESSAGE, m_hopCount, m_message, m_messageSequenceNumber, m_messageSize, m_messageType, m_originatorAddress, m_timeToLive, m_vTime, MID_MESSAGE, NS_ASSERT, OLSR_MSG_HEADER_SIZE, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU8(), visualizer.core::start(), and TC_MESSAGE.

◆ GetHello() [1/2]

Hello& ns3::olsr::MessageHeader::GetHello ( )

inline

Set the message type to HELLO and return the message content.

Returns: The HELLO message.

Definition at line 591 of file olsr-header.h.

References HELLO_MESSAGE, m_message, m_messageType, and NS_ASSERT.

Referenced by ns3::olsr::RoutingProtocol::ProcessHello(), ns3::olsr::HelloRegressionTest::ReceivePktProbeA(), ns3::olsr::TcRegressionTest::ReceivePktProbeA(), ns3::olsr::HelloRegressionTest::ReceivePktProbeB(), ns3::olsr::TcRegressionTest::ReceivePktProbeB(), ns3::olsr::TcRegressionTest::ReceivePktProbeC(), and ns3::olsr::RoutingProtocol::SendHello().

◆ GetHello() [2/2]

const Hello& ns3::olsr::MessageHeader::GetHello ( ) const

inline

Get the HELLO message.

Returns: The HELLO message.

Definition at line 653 of file olsr-header.h.

References HELLO_MESSAGE, m_message, m_messageType, and NS_ASSERT.

◆ GetHna() [1/2]

Hna& ns3::olsr::MessageHeader::GetHna ( )

inline

Set the message type to HNA and return the message content.

Returns: The HNA message.

Definition at line 625 of file olsr-header.h.

References HNA_MESSAGE, m_message, m_messageType, and NS_ASSERT.

Referenced by ns3::olsr::RoutingProtocol::ProcessHna(), and ns3::olsr::RoutingProtocol::SendHna().

◆ GetHna() [2/2]

const Hna& ns3::olsr::MessageHeader::GetHna ( ) const

inline

Get the HNA message.

Returns: The HNA message.

Definition at line 673 of file olsr-header.h.

References HNA_MESSAGE, m_message, m_messageType, and NS_ASSERT.

◆ GetHopCount()

uint8_t ns3::olsr::MessageHeader::GetHopCount ( void ) const

inline

Get the hop count.

Returns: The hop count.

Definition at line 254 of file olsr-header.h.

References m_hopCount.

Referenced by ns3::olsr::RoutingProtocol::ForwardDefault().

◆ GetInstanceTypeId()

TypeId ns3::olsr::MessageHeader::GetInstanceTypeId ( void ) 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 183 of file olsr-header.cc.

References GetTypeId().

◆ GetMessageSequenceNumber()

uint16_t ns3::olsr::MessageHeader::GetMessageSequenceNumber ( ) const

inline

Get the message sequence number.

Returns: The message sequence number.

Definition at line 271 of file olsr-header.h.

References m_messageSequenceNumber.

Referenced by ns3::olsr::RoutingProtocol::ForwardDefault(), and ns3::olsr::RoutingProtocol::RecvOlsr().

◆ GetMessageType()

MessageType ns3::olsr::MessageHeader::GetMessageType ( void ) const

inline

Get the message type.

Returns: The message type.

Definition at line 186 of file olsr-header.h.

References m_messageType.

Referenced by ns3::olsr::RoutingProtocol::RecvOlsr().

◆ GetMid() [1/2]

Mid& ns3::olsr::MessageHeader::GetMid ( )

inline

Set the message type to MID and return the message content.

Returns: The MID message.

Definition at line 574 of file olsr-header.h.

References m_message, m_messageType, MID_MESSAGE, and NS_ASSERT.

Referenced by ns3::olsr::RoutingProtocol::ProcessMid(), and ns3::olsr::RoutingProtocol::SendMid().

◆ GetMid() [2/2]

const Mid& ns3::olsr::MessageHeader::GetMid ( ) const

inline

Get the MID message.

Returns: The MID message.

Definition at line 643 of file olsr-header.h.

References m_message, m_messageType, MID_MESSAGE, and NS_ASSERT.

◆ GetOriginatorAddress()

Ipv4Address ns3::olsr::MessageHeader::GetOriginatorAddress ( void ) const

inline

Get the originator address.

Returns: The originator address.

Definition at line 220 of file olsr-header.h.

References m_originatorAddress.

◆ GetSerializedSize()

uint32_t ns3::olsr::MessageHeader::GetSerializedSize ( void ) 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 189 of file olsr-header.cc.

References HELLO_MESSAGE, HNA_MESSAGE, m_message, m_messageType, MID_MESSAGE, NS_ASSERT, NS_LOG_DEBUG, OLSR_MSG_HEADER_SIZE, and TC_MESSAGE.

Referenced by ns3::olsr::MessageHeader::Mid::Deserialize(), ns3::olsr::RoutingProtocol::RecvOlsr(), ns3::olsr::RoutingProtocol::SendHello(), and Serialize().

◆ GetTc() [1/2]

Tc& ns3::olsr::MessageHeader::GetTc ( )

inline

Set the message type to TC and return the message content.

Returns: The TC message.

Definition at line 608 of file olsr-header.h.

References m_message, m_messageType, NS_ASSERT, and TC_MESSAGE.

Referenced by ns3::olsr::RoutingProtocol::ProcessTc(), ns3::olsr::TcRegressionTest::ReceivePktProbeA(), ns3::olsr::TcRegressionTest::ReceivePktProbeC(), and ns3::olsr::RoutingProtocol::SendTc().

◆ GetTc() [2/2]

const Tc& ns3::olsr::MessageHeader::GetTc ( ) const

inline

Get the TC message.

Returns: The TC message.

Definition at line 663 of file olsr-header.h.

References m_message, m_messageType, NS_ASSERT, and TC_MESSAGE.

◆ GetTimeToLive()

uint8_t ns3::olsr::MessageHeader::GetTimeToLive ( ) const

inline

Get the time to live.

Returns: The time to live.

Definition at line 237 of file olsr-header.h.

References m_timeToLive.

Referenced by ns3::olsr::RoutingProtocol::ForwardDefault(), and ns3::olsr::RoutingProtocol::RecvOlsr().

◆ GetTypeId()

TypeId ns3::olsr::MessageHeader::GetTypeId ( void )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 173 of file olsr-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

◆ GetVTime()

Time ns3::olsr::MessageHeader::GetVTime ( ) const

inline

Get the validity time.

Returns: The validity time.

Definition at line 203 of file olsr-header.h.

References ns3::olsr::EmfToSeconds(), m_vTime, and ns3::Seconds().

Referenced by ns3::olsr::RoutingProtocol::LinkSensing(), ns3::olsr::RoutingProtocol::PopulateMprSelectorSet(), ns3::olsr::RoutingProtocol::PopulateTwoHopNeighborSet(), ns3::olsr::RoutingProtocol::ProcessHna(), ns3::olsr::RoutingProtocol::ProcessMid(), and ns3::olsr::RoutingProtocol::ProcessTc().

◆ Print()

void ns3::olsr::MessageHeader::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

Todo:

Implements ns3::Header.

Definition at line 214 of file olsr-header.cc.

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

◆ Serialize()

void ns3::olsr::MessageHeader::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 220 of file olsr-header.cc.

References ns3::Ipv4Address::Get(), GetSerializedSize(), HELLO_MESSAGE, HNA_MESSAGE, m_hopCount, m_message, m_messageSequenceNumber, m_messageType, m_originatorAddress, m_timeToLive, m_vTime, MID_MESSAGE, NS_ASSERT, visualizer.core::start(), TC_MESSAGE, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().

◆ SetHopCount()

void ns3::olsr::MessageHeader::SetHopCount ( uint8_t hopCount )

inline

Set the hop count.

Parameters

hopCount The hop count.

Definition at line 246 of file olsr-header.h.

References m_hopCount.

Referenced by ns3::olsr::RoutingProtocol::ForwardDefault(), ns3::olsr::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendHna(), ns3::olsr::RoutingProtocol::SendMid(), and ns3::olsr::RoutingProtocol::SendTc().

◆ SetMessageSequenceNumber()

void ns3::olsr::MessageHeader::SetMessageSequenceNumber ( uint16_t messageSequenceNumber )

inline

Set the message sequence number.

Parameters

messageSequenceNumber The message sequence number.

Definition at line 263 of file olsr-header.h.

References m_messageSequenceNumber.

Referenced by ns3::olsr::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendHna(), ns3::olsr::RoutingProtocol::SendMid(), and ns3::olsr::RoutingProtocol::SendTc().

◆ SetMessageType()

void ns3::olsr::MessageHeader::SetMessageType ( MessageType messageType )

inline

Set the message type.

Parameters

messageType The message type.

Definition at line 178 of file olsr-header.h.

References m_messageType.

◆ SetOriginatorAddress()

void ns3::olsr::MessageHeader::SetOriginatorAddress ( Ipv4Address originatorAddress )

inline

Set the originator address.

Parameters

originatorAddress The originator address.

Definition at line 212 of file olsr-header.h.

References m_originatorAddress.

Referenced by ns3::olsr::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendHna(), ns3::olsr::RoutingProtocol::SendMid(), and ns3::olsr::RoutingProtocol::SendTc().

◆ SetTimeToLive()

void ns3::olsr::MessageHeader::SetTimeToLive ( uint8_t timeToLive )

inline

Set the time to live.

Parameters

timeToLive The time to live.

Definition at line 229 of file olsr-header.h.

References m_timeToLive.

Referenced by ns3::olsr::RoutingProtocol::ForwardDefault(), ns3::olsr::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendHna(), ns3::olsr::RoutingProtocol::SendMid(), and ns3::olsr::RoutingProtocol::SendTc().

◆ SetVTime()

void ns3::olsr::MessageHeader::SetVTime ( Time time )

inline

Set the validity time.

Parameters

time	The validity time.

Definition at line 195 of file olsr-header.h.

References ns3::Time::GetSeconds(), m_vTime, and ns3::olsr::SecondsToEmf().

Referenced by ns3::olsr::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendHna(), ns3::olsr::RoutingProtocol::SendMid(), and ns3::olsr::RoutingProtocol::SendTc().

Member Data Documentation

◆ hello

Hello ns3::olsr::MessageHeader::hello

HELLO message (optional).

Definition at line 564 of file olsr-header.h.

◆ hna

Hna ns3::olsr::MessageHeader::hna

HNA message (optional).

Definition at line 566 of file olsr-header.h.

◆ m_hopCount

uint8_t ns3::olsr::MessageHeader::m_hopCount

private

The hop count.

Definition at line 281 of file olsr-header.h.

Referenced by Deserialize(), GetHopCount(), Serialize(), and SetHopCount().

◆ m_message

struct { ... } ns3::olsr::MessageHeader::m_message

Structure holding the message content.

The actual message being carried.

Referenced by Deserialize(), GetHello(), GetHna(), GetMid(), GetSerializedSize(), GetTc(), and Serialize().

◆ m_messageSequenceNumber

uint16_t ns3::olsr::MessageHeader::m_messageSequenceNumber

private

The message sequence number.

Definition at line 282 of file olsr-header.h.

Referenced by Deserialize(), GetMessageSequenceNumber(), Serialize(), and SetMessageSequenceNumber().

◆ m_messageSize

uint16_t ns3::olsr::MessageHeader::m_messageSize

private

The message size.

Definition at line 283 of file olsr-header.h.

Referenced by Deserialize().

◆ m_messageType

MessageType ns3::olsr::MessageHeader::m_messageType

private

The message type.

Definition at line 277 of file olsr-header.h.

Referenced by Deserialize(), GetHello(), GetHna(), GetMessageType(), GetMid(), GetSerializedSize(), GetTc(), Serialize(), and SetMessageType().

◆ m_originatorAddress

Ipv4Address ns3::olsr::MessageHeader::m_originatorAddress

private

The originator address.

Definition at line 279 of file olsr-header.h.

Referenced by Deserialize(), GetOriginatorAddress(), Serialize(), and SetOriginatorAddress().

◆ m_timeToLive

uint8_t ns3::olsr::MessageHeader::m_timeToLive

private

The time to live.

Definition at line 280 of file olsr-header.h.

Referenced by Deserialize(), GetTimeToLive(), Serialize(), and SetTimeToLive().

◆ m_vTime

uint8_t ns3::olsr::MessageHeader::m_vTime

private

The validity time.

Definition at line 278 of file olsr-header.h.

Referenced by Deserialize(), GetVTime(), Serialize(), and SetVTime().

◆ mid

Mid ns3::olsr::MessageHeader::mid

MID message (optional).

Definition at line 563 of file olsr-header.h.

◆ tc

Tc ns3::olsr::MessageHeader::tc

TC message (optional).

Definition at line 565 of file olsr-header.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MessageType

Constructor & Destructor Documentation

◆ MessageHeader()

◆ ~MessageHeader()

Member Function Documentation

◆ Deserialize()

◆ GetHello() [1/2]

◆ GetHello() [2/2]

◆ GetHna() [1/2]

◆ GetHna() [2/2]

◆ GetHopCount()

◆ GetInstanceTypeId()

◆ GetMessageSequenceNumber()

◆ GetMessageType()

◆ GetMid() [1/2]

◆ GetMid() [2/2]

◆ GetOriginatorAddress()

◆ GetSerializedSize()

◆ GetTc() [1/2]

◆ GetTc() [2/2]

◆ GetTimeToLive()

◆ GetTypeId()

◆ GetVTime()

◆ Print()

◆ Serialize()

◆ SetHopCount()

◆ SetMessageSequenceNumber()

◆ SetMessageType()

◆ SetOriginatorAddress()

◆ SetTimeToLive()

◆ SetVTime()

Member Data Documentation

◆ hello

◆ hna

◆ m_hopCount

◆ m_message

◆ m_messageSequenceNumber

◆ m_messageSize

◆ m_messageType

◆ m_originatorAddress

◆ m_timeToLive

◆ m_vTime

◆ mid

◆ tc