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 More...
 
bool AddUnDestination (Ipv4Address dst, uint32_t seqNo)
 Add unreachable node address and its sequence number in RERR header. More...
 
void Clear ()
 Clear header. More...
 
uint8_t GetDestCount () const
 Return number of unreachable destinations in RERR message. More...
 
bool operator== (RerrHeader const &o) const
 
bool RemoveUnDestination (std::pair< Ipv4Address, uint32_t > &un)
 Delete pair (address + sequence number) from REER header, if the number of unreachable destinations > 0. More...
 
No delete flag
void SetNoDelete (bool f)
 
bool GetNoDelete () const
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Private Attributes

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

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

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Route Error (RERR) Message Format.

Doxygen introspection did not find any typical Config paths.

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)|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


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

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

Constructor & Destructor Documentation

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

c-tor

Definition at line 491 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 584 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 606 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 535 of file aodv-packet.cc.

References first::address, 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 509 of file aodv-packet.cc.

References GetTypeId().

+ Here is the call graph for this function:

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

Definition at line 578 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 515 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

Definition at line 499 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 614 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 557 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 595 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 521 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 569 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: