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

#include "olsr-header.h"

Inheritance diagram for ns3::olsr::MessageHeader:

Collaboration 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 ()

	~MessageHeader () override

uint32_t	Deserialize (Buffer::Iterator start) override

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

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

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

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

uint8_t	GetHopCount () const
	Get the hop count.

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

uint16_t	GetMessageSequenceNumber () const
	Get the message sequence number.

MessageType	GetMessageType () const
	Get the message type.

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

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

Ipv4Address	GetOriginatorAddress () const
	Get the originator address.

uint32_t	GetSerializedSize () const override

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

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

uint8_t	GetTimeToLive () const
	Get the time to live.

Time	GetVTime () const
	Get the validity time.

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

void	Serialize (Buffer::Iterator start) const override

void	SetHopCount (uint8_t hopCount)
	Set the hop count.

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

void	SetMessageType (MessageType messageType)
	Set the message type.

void	SetOriginatorAddress (Ipv4Address originatorAddress)
	Set the originator address.

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

void	SetVTime (Time time)
	Set the validity time.

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
uint8_t	m_hopCount
	The hop count.

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.

uint16_t	m_messageSequenceNumber
	The message sequence number.

uint16_t	m_messageSize
	The message size.

MessageType	m_messageType
	The message type.

Ipv4Address	m_originatorAddress
	The originator address.

uint8_t	m_timeToLive
	The time to live.

uint8_t	m_vTime
	The validity time.

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

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 160 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 166 of file olsr-header.h.

Constructor & Destructor Documentation

◆ MessageHeader()

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

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

◆ ~MessageHeader()

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

override

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::olsr::MessageHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

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 289 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(), and TC_MESSAGE.

Here is the call graph for this function:

◆ 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 601 of file olsr-header.h.

References HELLO_MESSAGE, m_message, m_messageType, and NS_ASSERT.

Referenced by OlsrHelloTestCase::DoRun(), 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().

Here is the caller graph for this function:

◆ GetHello() [2/2]

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

inline

Get the HELLO message.

Returns: The HELLO message.

Definition at line 662 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 635 of file olsr-header.h.

References HNA_MESSAGE, m_message, m_messageType, and NS_ASSERT.

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

Here is the caller graph for this function:

◆ GetHna() [2/2]

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

inline

Get the HNA message.

Returns: The HNA message.

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

References HNA_MESSAGE, m_message, m_messageType, and NS_ASSERT.

◆ GetHopCount()

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

inline

Get the hop count.

Returns: The hop count.

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

References m_hopCount.

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::olsr::MessageHeader::GetInstanceTypeId ( ) const

overridevirtual

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 181 of file olsr-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetMessageSequenceNumber()

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

inline

Get the message sequence number.

Returns: The message sequence number.

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

References m_messageSequenceNumber.

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

Here is the caller graph for this function:

◆ GetMessageType()

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

inline

Get the message type.

Returns: The message type.

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

References m_messageType.

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

Here is the caller graph for this function:

◆ 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 584 of file olsr-header.h.

References m_message, m_messageType, MID_MESSAGE, and NS_ASSERT.

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

Here is the caller graph for this function:

◆ GetMid() [2/2]

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

inline

Get the MID message.

Returns: The MID message.

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

References m_message, m_messageType, MID_MESSAGE, and NS_ASSERT.

◆ GetOriginatorAddress()

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

inline

Get the originator address.

Returns: The originator address.

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

References m_originatorAddress.

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::olsr::MessageHeader::GetSerializedSize ( ) const

overridevirtual

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 187 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(), OlsrMidTestCase::DoRun(), ns3::olsr::RoutingProtocol::RecvOlsr(), ns3::olsr::RoutingProtocol::SendHello(), and Serialize().

Here is the caller graph for this function:

◆ 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 618 of file olsr-header.h.

References m_message, m_messageType, NS_ASSERT, and TC_MESSAGE.

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

Here is the caller graph for this function:

◆ GetTc() [2/2]

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

inline

Get the TC message.

Returns: The TC message.

Definition at line 672 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 244 of file olsr-header.h.

References m_timeToLive.

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

Here is the caller graph for this function:

◆ GetTypeId()

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

static

Get the type ID.

Returns: The object TypeId.

Definition at line 171 of file olsr-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:

◆ GetVTime()

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

inline

Get the validity time.

Returns: The validity time.

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

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

Referenced by OlsrMidTestCase::DoRun(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::olsr::MessageHeader::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 213 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, and TC_MESSAGE.

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

Here is the caller graph for this function:

◆ Serialize()

void ns3::olsr::MessageHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

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 258 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, TC_MESSAGE, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().