The basic layout of any packet in OLSR is as follows (omitting IP and UDP headers): More...

#include "olsr-header.h"

Inheritance diagram for ns3::olsr::PacketHeader:

Collaboration diagram for ns3::olsr::PacketHeader:

Public Member Functions
	PacketHeader ()

	~PacketHeader () override

uint32_t	Deserialize (Buffer::Iterator start) override

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

uint16_t	GetPacketLength () const
	Get the packet total length.

uint16_t	GetPacketSequenceNumber () const
	Get the packet sequence number.

uint32_t	GetSerializedSize () const override

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

void	Serialize (Buffer::Iterator start) const override

void	SetPacketLength (uint16_t length)
	Set the packet total length.

void	SetPacketSequenceNumber (uint16_t seqnum)
	Set the packet sequence number.

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

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

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

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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.

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
uint16_t	m_packetLength
	The packet length.

uint16_t	m_packetSequenceNumber
	The packet sequence number.

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 Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

The basic layout of any packet in OLSR is as follows (omitting IP and UDP headers):

Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Olsr
Size of this type is 16 bytes (on a 64-bit architecture).

  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
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |         Packet Length         |    Packet Sequence Number     |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Message Type |     Vtime     |         Message Size          |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                      Originator Address                       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Time To Live |   Hop Count   |    Message Sequence Number    |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               |
 :                            MESSAGE                            :
 |                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Message Type |     Vtime     |         Message Size          |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                      Originator Address                       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Time To Live |   Hop Count   |    Message Sequence Number    |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               |
 :                            MESSAGE                            :
 |                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 :                                                               :
          (etc.)

This header only holds the common part of a message group, i.e., the first 4 bytes.

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

Constructor & Destructor Documentation

◆ PacketHeader()

ns3::olsr::PacketHeader::PacketHeader ( )

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

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~PacketHeader()

ns3::olsr::PacketHeader::~PacketHeader ( )

override

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

Member Function Documentation

◆ Deserialize()

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

References GetSerializedSize(), m_packetLength, m_packetSequenceNumber, and ns3::Buffer::Iterator::ReadNtohU16().

Here is the call graph for this function:

◆ GetInstanceTypeId()

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

overridevirtual

Get the most derived TypeId for this Object.

This method is provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

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

Implements ns3::ObjectBase.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetPacketLength()

uint16_t ns3::olsr::PacketHeader::GetPacketLength ( ) const

inline

Get the packet total length.

Returns: The packet length.

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

References m_packetLength.

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

Here is the caller graph for this function:

◆ GetPacketSequenceNumber()

uint16_t ns3::olsr::PacketHeader::GetPacketSequenceNumber ( ) const

inline

Get the packet sequence number.

Returns: The packet sequence number.

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

References m_packetSequenceNumber.

Referenced by OlsrMidTestCase::DoRun().

Here is the caller graph for this function:

◆ GetSerializedSize()

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

References OLSR_PKT_HEADER_SIZE.

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

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::olsr::PacketHeader::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

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

References PacketHeader(), and 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::olsr::PacketHeader::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 124 of file olsr-header.cc.

References m_packetLength, and m_packetSequenceNumber.

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

Here is the caller graph for this function:

◆ Serialize()

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

References m_packetLength, m_packetSequenceNumber, and ns3::Buffer::Iterator::WriteHtonU16().

Here is the call graph for this function:

◆ SetPacketLength()

void ns3::olsr::PacketHeader::SetPacketLength ( uint16_t length )

inline

Set the packet total length.

Parameters

length The packet length.

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

References m_packetLength.

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

Here is the caller graph for this function:

◆ SetPacketSequenceNumber()

void ns3::olsr::PacketHeader::SetPacketSequenceNumber ( uint16_t seqnum )

inline

Set the packet sequence number.

Parameters

seqnum The packet sequence number.

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

References m_packetSequenceNumber.

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_packetLength

uint16_t ns3::olsr::PacketHeader::m_packetLength

private

The packet length.

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

Referenced by Deserialize(), GetPacketLength(), Print(), Serialize(), and SetPacketLength().

◆ m_packetSequenceNumber

uint16_t ns3::olsr::PacketHeader::m_packetSequenceNumber

private

The packet sequence number.

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

Referenced by Deserialize(), GetPacketSequenceNumber(), Print(), Serialize(), and SetPacketSequenceNumber().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PacketHeader()

◆ ~PacketHeader()

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetPacketLength()

◆ GetPacketSequenceNumber()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetPacketLength()

◆ SetPacketSequenceNumber()

Member Data Documentation

◆ m_packetLength

◆ m_packetSequenceNumber