RipNgHeader - see RFC 2080 More...

#include "ripng-header.h"

Inheritance diagram for ns3::RipNgHeader:

Collaboration diagram for ns3::RipNgHeader:

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

Public Member Functions
	RipNgHeader ()

void	AddRte (RipNgRte 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< RipNgRte >	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

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
uint8_t	m_command
	command type

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

Detailed Description

RipNgHeader - see RFC 2080

Definition at line 135 of file ripng-header.h.

Member Enumeration Documentation

◆ Command_e

enum ns3::RipNgHeader::Command_e

Commands to be used in RipNg headers.

Enumerator
REQUEST
RESPONSE

Definition at line 176 of file ripng-header.h.

Constructor & Destructor Documentation

◆ RipNgHeader()

ns3::RipNgHeader::RipNgHeader ( )

Definition at line 146 of file ripng-header.cc.

Member Function Documentation

◆ AddRte()

void ns3::RipNgHeader::AddRte ( RipNgRte rte )

Add a RTE to the message.

Parameters

rte the RTE

Definition at line 253 of file ripng-header.cc.

References m_rteList.

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

Here is the caller graph for this function:

◆ ClearRtes()

void ns3::RipNgHeader::ClearRtes ( )

Clear all the RTEs from the header.

Definition at line 259 of file ripng-header.cc.

References m_rteList.

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

Here is the caller graph for this function:

◆ Deserialize()

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

overridevirtual

Deserialize the packet.

Parameters

start Buffer iterator

Returns: size of the packet

Implements ns3::Header.

Definition at line 202 of file ripng-header.cc.

References ns3::RipNgRte::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()

RipNgHeader::Command_e ns3::RipNgHeader::GetCommand ( ) const

Get the command.

Returns: the command

Definition at line 247 of file ripng-header.cc.

References m_command.

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::RipNgHeader::GetInstanceTypeId ( ) const

overridevirtual

Return the instance type identifier.

Returns: instance type ID

Implements ns3::ObjectBase.

Definition at line 162 of file ripng-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetRteList()

std::list< RipNgRte > ns3::RipNgHeader::GetRteList ( ) const

Get the list of the RTEs included in the message.

Returns: the list of the RTEs in the message

Definition at line 271 of file ripng-header.cc.

References m_rteList.

Referenced by ns3::RipNg::HandleRequests(), ns3::RipNg::HandleResponses(), and Ipv6RipngSplitHorizonStrategyTest::ReceivePktProbe().

Here is the caller graph for this function:

◆ GetRteNumber()

uint16_t ns3::RipNgHeader::GetRteNumber ( ) const

Get the number of RTE included in the message.

Returns: the number of RTE in the message

Definition at line 265 of file ripng-header.cc.

References m_rteList.

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

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::RipNgHeader::GetSerializedSize ( ) const

overridevirtual

Get the serialized size of the packet.

Returns: size

Implements ns3::Header.

Definition at line 179 of file ripng-header.cc.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::RipNgHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 152 of file ripng-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::RipNgHeader::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 168 of file ripng-header.cc.

References m_command, and m_rteList.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ Serialize()

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

overridevirtual

Serialize the packet.

Parameters

start Buffer iterator

Implements ns3::Header.

Definition at line 186 of file ripng-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::RipNgHeader::SetCommand ( RipNgHeader::Command_e command )

Set the command.

Parameters

command the command

Definition at line 241 of file ripng-header.cc.

References m_command.

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_command

uint8_t ns3::RipNgHeader::m_command

private

command type

Definition at line 218 of file ripng-header.h.

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

◆ m_rteList

std::list<RipNgRte> ns3::RipNgHeader::m_rteList

private

list of the RTEs in the message

Definition at line 219 of file ripng-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/ripng-header.h
src/internet/model/ripng-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

◆ RipNgHeader()

Member Function Documentation

◆ AddRte()

◆ ClearRtes()

◆ Deserialize()

◆ GetCommand()

◆ GetInstanceTypeId()

◆ GetRteList()

◆ GetRteNumber()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetCommand()

Member Data Documentation

◆ m_command

◆ m_rteList