A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::aodv::RerrHeader Class Reference

Route Error (RERR) Message Format. More...

#include <aodv-packet.h>

+ Inheritance diagram for ns3::aodv::RerrHeader:
+ Collaboration diagram for ns3::aodv::RerrHeader:

Public Member Functions

 RerrHeader ()
 c-tor
bool AddUnDestination (Ipv4Address dst, uint32_t seqNo)
void Clear ()
 Clear header.
uint8_t GetDestCount () const
 Return number of unreachable destinations in RERR message.
bool operator== (RerrHeader const &o) const
bool RemoveUnDestination (std::pair< Ipv4Address, uint32_t > &un)
No delete flag
void SetNoDelete (bool f)
bool GetNoDelete () const
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Private Attributes

uint8_t m_flag
 No delete flag.
uint8_t m_reserved
 Not used.
std::map< Ipv4Address, uint32_t > m_unreachableDstSeqNo
 List of Unreachable destination: IP addresses and sequence numbers.

Header serialization/deserialization

TypeId GetInstanceTypeId () const
uint32_t GetSerializedSize () const
void Serialize (Buffer::Iterator i) const
uint32_t Deserialize (Buffer::Iterator start)
void Print (std::ostream &os) const
static TypeId GetTypeId ()
 This method returns the TypeId associated to ns3::aodv::RerrHeader.

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

Route Error (RERR) Message Format.

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Type      |N|          Reserved           |   DestCount   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            Unreachable Destination IP Address (1)             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|         Unreachable Destination Sequence Number (1)           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-|
|  Additional Unreachable Destination IP Addresses (if needed)  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Additional Unreachable Destination Sequence Numbers (if needed)|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

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

Constructor & Destructor Documentation

ns3::aodv::RerrHeader::RerrHeader ( )

c-tor

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

Member Function Documentation

bool ns3::aodv::RerrHeader::AddUnDestination ( Ipv4Address  dst,
uint32_t  seqNo 
)

Add unreachable node address and its sequence number in RERR header

Returns
false if we already added maximum possible number of unreachable destinations

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

References GetDestCount(), m_unreachableDstSeqNo, and NS_ASSERT.

Referenced by ns3::aodv::RerrHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvError(), ns3::aodv::RoutingProtocol::SendRerrWhenBreaksLinkToNextHop(), and ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::aodv::RerrHeader::Clear ( )

Clear header.

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

References m_flag, m_reserved, and m_unreachableDstSeqNo.

Referenced by ns3::aodv::RoutingProtocol::RecvError(), and ns3::aodv::RoutingProtocol::SendRerrWhenBreaksLinkToNextHop().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RerrHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should written.
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.

Implements ns3::Header.

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

References ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_flag, m_reserved, m_unreachableDstSeqNo, NS_ASSERT, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint8_t ns3::aodv::RerrHeader::GetDestCount ( ) const
inline

Return number of unreachable destinations in RERR message.

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

References m_unreachableDstSeqNo.

Referenced by AddUnDestination(), ns3::aodv::RerrHeaderTest::DoRun(), GetSerializedSize(), operator==(), ns3::aodv::RoutingProtocol::RecvError(), ns3::aodv::RoutingProtocol::SendRerrWhenBreaksLinkToNextHop(), and Serialize().

+ Here is the caller graph for this function:

TypeId ns3::aodv::RerrHeader::GetInstanceTypeId ( ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

bool ns3::aodv::RerrHeader::GetNoDelete ( ) const

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

References m_flag.

Referenced by ns3::aodv::RerrHeaderTest::DoRun().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RerrHeader::GetSerializedSize ( ) const
virtual
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 514 of file aodv-packet.cc.

References GetDestCount().

Referenced by Deserialize(), and ns3::aodv::RerrHeaderTest::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

TypeId ns3::aodv::RerrHeader::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::aodv::RerrHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References GetDestCount(), m_flag, m_reserved, and m_unreachableDstSeqNo.

+ Here is the call graph for this function:

void ns3::aodv::RerrHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 556 of file aodv-packet.cc.

References m_unreachableDstSeqNo.

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

+ Here is the caller graph for this function:

bool ns3::aodv::RerrHeader::RemoveUnDestination ( std::pair< Ipv4Address, uint32_t > &  un)

Delete pair (address + sequence number) from REER header, if the number of unreachable destinations > 0

Returns
true on success

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

References m_unreachableDstSeqNo.

Referenced by ns3::aodv::RoutingProtocol::RecvError().

+ Here is the caller graph for this function:

void ns3::aodv::RerrHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 520 of file aodv-packet.cc.

References GetDestCount(), m_flag, m_reserved, m_unreachableDstSeqNo, ns3::Buffer::Iterator::WriteHtonU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::aodv::RerrHeader::SetNoDelete ( bool  f)

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

References m_flag.

Referenced by ns3::aodv::RerrHeaderTest::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::aodv::RerrHeader::m_flag
private

No delete flag.

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

Referenced by Clear(), Deserialize(), GetNoDelete(), operator==(), Serialize(), and SetNoDelete().

uint8_t ns3::aodv::RerrHeader::m_reserved
private

Not used.

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

Referenced by Clear(), Deserialize(), operator==(), and Serialize().

std::map<Ipv4Address, uint32_t> ns3::aodv::RerrHeader::m_unreachableDstSeqNo
private

List of Unreachable destination: IP addresses and sequence numbers.

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

Referenced by AddUnDestination(), Clear(), Deserialize(), GetDestCount(), operator==(), Print(), RemoveUnDestination(), and Serialize().


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