AODV types. More...

#include "aodv-packet.h"

Inheritance diagram for ns3::aodv::TypeHeader:

Collaboration diagram for ns3::aodv::TypeHeader:

Public Member Functions
	TypeHeader (MessageType t=AODVTYPE_RREQ)
	constructor
uint32_t	Deserialize (Buffer::Iterator start) override
MessageType	Get () const
TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.
uint32_t	GetSerializedSize () const override
bool	IsValid () const
	Check that type if valid.
bool	operator== (const TypeHeader &o) const
	Comparison operator.
void	Print (std::ostream &os) const override
void	Serialize (Buffer::Iterator start) const override
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
MessageType	m_type
	type of the message
bool	m_valid
	Indicates if the message is valid.

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

AODV types.

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

Definition at line 48 of file aodv-packet.h.

Constructor & Destructor Documentation

◆ TypeHeader()

ns3::aodv::TypeHeader::TypeHeader ( MessageType t = AODVTYPE_RREQ )

constructor

Parameters

t	the AODV RREQ type

Definition at line 28 of file aodv-packet.cc.

References m_type, and m_valid.

Referenced by GetTypeId(), and operator==().

Here is the caller graph for this function:

Member Function Documentation

◆ Deserialize()

uint32_t ns3::aodv::TypeHeader::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 63 of file aodv-packet.cc.

References ns3::aodv::AODVTYPE_RERR, ns3::aodv::AODVTYPE_RREP, ns3::aodv::AODVTYPE_RREP_ACK, ns3::aodv::AODVTYPE_RREQ, ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_type, m_valid, NS_ASSERT, and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ Get()

MessageType ns3::aodv::TypeHeader::Get ( ) const

inline

Returns: the type

Definition at line 71 of file aodv-packet.h.

References m_type.

Referenced by ns3::aodv::TypeHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvAodv().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::aodv::TypeHeader::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 45 of file aodv-packet.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::aodv::TypeHeader::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 51 of file aodv-packet.cc.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::aodv::TypeHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file aodv-packet.cc.

References TypeHeader(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValid()

bool ns3::aodv::TypeHeader::IsValid ( ) const

inline

Check that type if valid.

Returns: true if the type is valid

Definition at line 80 of file aodv-packet.h.

References m_valid.

Referenced by ns3::aodv::TypeHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvAodv().

Here is the caller graph for this function:

◆ operator==()

bool ns3::aodv::TypeHeader::operator== ( const TypeHeader & o ) const

Comparison operator.

Parameters

o	header to compare

Returns: true if the headers are equal

Definition at line 112 of file aodv-packet.cc.

References TypeHeader(), m_type, and m_valid.

Here is the call graph for this function:

◆ Print()

void ns3::aodv::TypeHeader::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 86 of file aodv-packet.cc.

References ns3::aodv::AODVTYPE_RERR, ns3::aodv::AODVTYPE_RREP, ns3::aodv::AODVTYPE_RREP_ACK, ns3::aodv::AODVTYPE_RREQ, and m_type.

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

Here is the caller graph for this function:

◆ Serialize()

void ns3::aodv::TypeHeader::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 57 of file aodv-packet.cc.

References m_type, and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

Member Data Documentation

◆ m_type

MessageType ns3::aodv::TypeHeader::m_type

private

type of the message

Definition at line 93 of file aodv-packet.h.

Referenced by TypeHeader(), Deserialize(), Get(), operator==(), Print(), and Serialize().

◆ m_valid

bool ns3::aodv::TypeHeader::m_valid

private

Indicates if the message is valid.

Definition at line 94 of file aodv-packet.h.

Referenced by TypeHeader(), Deserialize(), IsValid(), and operator==().

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

src/aodv/model/aodv-packet.h
src/aodv/model/aodv-packet.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TypeHeader()

Member Function Documentation

◆ Deserialize()

◆ Get()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetTypeId()

◆ IsValid()

◆ operator==()

◆ Print()

◆ Serialize()

Member Data Documentation

◆ m_type

◆ m_valid