A Discrete-Event Network Simulator
API
ns3::RipHeader Class Reference

RipHeader - see RFC 2453 More...

#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)
 
void AddRte (RipRte rte)
 Add a RTE to the message. More...
 
void ClearRtes ()
 Clear all the RTEs from the header. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet. More...
 
Command_e GetCommand (void) const
 Get the command. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Return the instance type identifier. More...
 
std::list< RipRteGetRteList (void) const
 Get the list of the RTEs included in the message. More...
 
uint16_t GetRteNumber (void) const
 Get the number of RTE included in the message. More...
 
virtual uint32_t GetSerializedSize (void) const
 Get the serialized size of the packet. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet. More...
 
void SetCommand (Command_e command)
 Set the command. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t GetSerializedSize (void) const =0
 
virtual void Print (std::ostream &os) const =0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual void Print (std::ostream &os) const =0
 Print the object contents. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_command
 command type More...
 
std::list< RipRtem_rteList
 list of the RTEs in the message More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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

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

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

Member Function Documentation

◆ AddRte()

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

Add a RTE to the message.

Parameters
rtethe RTE

Definition at line 257 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 262 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)
virtual

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Implements ns3::Header.

Definition at line 209 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, RESPONSE, and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetCommand()

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

Get the command.

Returns
the command

Definition at line 252 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 ( void  ) const
virtual

Return the instance type identifier.

Returns
instance type ID

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetRteList()

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

Get the list of the RTEs included in the message.

Returns
the list of the RTEs in the message

Definition at line 272 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 ( void  ) const

Get the number of RTE included in the message.

Returns
the number of RTE in the message

Definition at line 267 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 ( void  ) const
virtual

Get the serialized size of the packet.

Returns
size

Implements ns3::Header.

Definition at line 187 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 ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 162 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
virtual
Parameters
osoutput 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 176 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
virtual

Serialize the packet.

Parameters
startBuffer iterator

Implements ns3::Header.

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

References m_command, m_rteList, ns3::Buffer::Iterator::Next(), visualizer.core::start(), 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
commandthe command

Definition at line 247 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: