#include "rip-header.h"

Inheritance diagram for ns3::RipHeader:

Collaboration diagram for ns3::RipHeader:

Public Types
enum	Command_e { REQUEST = 0x1 , RESPONSE = 0x2 }
	Commands to be used in Rip headers. More...

Public Member Functions
	RipHeader ()

void	AddRte (RipRte rte)
	Add a RTE to the message.

void	ClearRtes ()
	Clear all the RTEs from the header.

uint32_t	Deserialize (Buffer::Iterator start) override
	Deserialize the packet.

Command_e	GetCommand () const
	Get the command.

TypeId	GetInstanceTypeId () const override
	Return the instance type identifier.

std::list< RipRte >	GetRteList () const
	Get the list of the RTEs included in the message.

uint16_t	GetRteNumber () const
	Get the number of RTE included in the message.

uint32_t	GetSerializedSize () const override
	Get the serialized size of the packet.

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

void	Serialize (Buffer::Iterator start) const override
	Serialize the packet.

void	SetCommand (Command_e command)
	Set the command.

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_command
	command type

std::list< RipRte >	m_rteList
	list of the RTEs in the message

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

RipHeader - see RFC 2453

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 32 bytes (on a 64-bit architecture).

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

Member Enumeration Documentation

◆ Command_e

enum ns3::RipHeader::Command_e

Commands to be used in Rip headers.

Enumerator
REQUEST
RESPONSE

Definition at line 198 of file rip-header.h.

Constructor & Destructor Documentation

◆ RipHeader()

ns3::RipHeader::RipHeader ( )

Definition at line 175 of file rip-header.cc.

Member Function Documentation

◆ AddRte()

void ns3::RipHeader::AddRte ( RipRte rte )

Add a RTE to the message.

Parameters

rte the RTE

Definition at line 282 of file rip-header.cc.

References m_rteList.

Referenced by ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), and ns3::Rip::SendRouteRequest().

Here is the caller graph for this function:

◆ ClearRtes()

void ns3::RipHeader::ClearRtes ( )

Clear all the RTEs from the header.

Definition at line 288 of file rip-header.cc.

References m_rteList.

Referenced by ns3::Rip::DoSendRouteUpdate(), and ns3::Rip::HandleRequests().

Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::RipHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Deserialize the packet.

Parameters

start Buffer iterator

Returns: size of the packet

Implements ns3::Header.

Definition at line 231 of file rip-header.cc.

References ns3::RipRte::Deserialize(), ns3::Buffer::Iterator::GetRemainingSize(), GetSerializedSize(), m_command, m_rteList, ns3::Buffer::Iterator::Next(), NS_LOG_LOGIC, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), REQUEST, and RESPONSE.

Here is the call graph for this function:

◆ GetCommand()

RipHeader::Command_e ns3::RipHeader::GetCommand ( ) const

Get the command.

Returns: the command

Definition at line 276 of file rip-header.cc.

References m_command.

Referenced by ns3::Rip::Receive().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::RipHeader::GetInstanceTypeId ( ) const

overridevirtual

Return the instance type identifier.

Returns: instance type ID

Implements ns3::ObjectBase.

Definition at line 191 of file rip-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetRteList()

std::list< RipRte > ns3::RipHeader::GetRteList ( ) const

Get the list of the RTEs included in the message.

Returns: the list of the RTEs in the message

Definition at line 300 of file rip-header.cc.

References m_rteList.

Referenced by ns3::Rip::HandleRequests(), ns3::Rip::HandleResponses(), and Ipv4RipSplitHorizonStrategyTest::ReceivePktProbe().

Here is the caller graph for this function:

◆ GetRteNumber()

uint16_t ns3::RipHeader::GetRteNumber ( ) const

Get the number of RTE included in the message.

Returns: the number of RTE in the message

Definition at line 294 of file rip-header.cc.

References m_rteList.

Referenced by ns3::Rip::DoSendRouteUpdate(), and ns3::Rip::HandleRequests().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::RipHeader::GetSerializedSize ( ) const

overridevirtual

Get the serialized size of the packet.

Returns: size

Implements ns3::Header.

Definition at line 208 of file rip-header.cc.

References ns3::RipRte::GetSerializedSize(), and m_rteList.

Referenced by Deserialize(), ns3::Rip::DoSendRouteUpdate(), and ns3::Rip::HandleRequests().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::RipHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 181 of file rip-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::RipHeader::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 197 of file rip-header.cc.

References m_command, and m_rteList.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ Serialize()

void ns3::RipHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Serialize the packet.

Parameters

start Buffer iterator

Implements ns3::Header.

Definition at line 215 of file rip-header.cc.

References m_command, m_rteList, ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetCommand()

void ns3::RipHeader::SetCommand ( RipHeader::Command_e command )

Set the command.

Parameters

command the command

Definition at line 270 of file rip-header.cc.

References m_command.

Referenced by ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), and ns3::Rip::SendRouteRequest().

Here is the caller graph for this function:

Member Data Documentation

◆ m_command

uint8_t ns3::RipHeader::m_command

private

command type

Definition at line 240 of file rip-header.h.

Referenced by Deserialize(), GetCommand(), Print(), Serialize(), and SetCommand().

◆ m_rteList

std::list<RipRte> ns3::RipHeader::m_rteList

private

list of the RTEs in the message

Definition at line 241 of file rip-header.h.

Referenced by AddRte(), ClearRtes(), Deserialize(), GetRteList(), GetRteNumber(), GetSerializedSize(), Print(), and Serialize().

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

src/internet/model/rip-header.h
src/internet/model/rip-header.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Command_e

Constructor & Destructor Documentation

◆ RipHeader()

Member Function Documentation

◆ AddRte()

◆ ClearRtes()

◆ Deserialize()

◆ GetCommand()

◆ GetInstanceTypeId()

◆ GetRteList()

◆ GetRteNumber()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetCommand()

Member Data Documentation

◆ m_command

◆ m_rteList