A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::dsr::DsrOptionRerrUnreachHeader Class Reference
DSR Routing

Route Error (RERR) Unreachable node address option Message Format. More...

#include <dsr-option-header.h>

+ Inheritance diagram for ns3::dsr::DsrOptionRerrUnreachHeader:
+ Collaboration diagram for ns3::dsr::DsrOptionRerrUnreachHeader:

Public Member Functions

 DsrOptionRerrUnreachHeader ()
 Constructor.
virtual ~DsrOptionRerrUnreachHeader ()
 Destructor.
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet.
virtual Alignment GetAlignment () const
 Get the Alignment requirement of this option header.
virtual Ipv4Address GetErrorDst () const
 Get the error destination ip address.
virtual Ipv4Address GetErrorSrc () const
 Get the route error source address.
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID.
Ipv4Address GetOriginalDst () const
 Get the unreachable node ip address.
virtual uint8_t GetSalvage () const
 Get the salvage value of the packet.
virtual uint32_t GetSerializedSize () const
 Get the serialized size of the packet.
Ipv4Address GetUnreachNode () const
 Get the unreachable node ip address.
virtual void Print (std::ostream &os) const
 Print some informations about the packet.
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet.
virtual void SetErrorDst (Ipv4Address errorDstAddress)
 Set the error destination ip address.
virtual void SetErrorSrc (Ipv4Address errorSrcAddress)
 Set the route error source address.
void SetOriginalDst (Ipv4Address originalDst)
 Set the unreachable node ip address.
virtual void SetSalvage (uint8_t salvage)
 Set the salvage value of the packet.
void SetUnreachNode (Ipv4Address unreachNode)
 Set the unreachable node ip address.
- Public Member Functions inherited from ns3::dsr::DsrOptionRerrHeader
 DsrOptionRerrHeader ()
 Constructor.
virtual ~DsrOptionRerrHeader ()
 Destructor.
uint8_t GetErrorType () const
 Get the route error type.
void SetErrorType (uint8_t errorType)
 Set the route error type.
- Public Member Functions inherited from ns3::dsr::DsrOptionHeader
 DsrOptionHeader ()
 Constructor.
virtual ~DsrOptionHeader ()
 Destructor.
uint8_t GetLength () const
 Get the option length.
uint8_t GetType () const
 Get the type of the option.
void SetLength (uint8_t length)
 Set the option length.
void SetType (uint8_t type)
 Set the type of the option.
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type identificator.

Private Attributes

Ipv4Address m_errorDstAddress
 The error destination address.
Ipv4Address m_errorSrcAddress
 The error source address.
uint8_t m_errorType
 The error type or route error option.
uint8_t m_optDataLen
 option data length
Ipv4Address m_originalDst
 The original destination address.
uint8_t m_reserved
 The reserved field.
uint8_t m_salvage
 The salavage field.
uint16_t m_typeSpecific
 The specific error type.
Ipv4Address m_unreachNode
 The unreachable node address.

Additional Inherited Members

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

Detailed Description

Route Error (RERR) Unreachable node address option Message Format. 

 |      0        |      1        |      2        |      3        |
 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Option Type |  Opt Data Len |   Error Type  |Reservd| Salvage|
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                      Error Source Address                     |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                    Error Destination Address                  |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 .                                                               .
 .                    Type-Specific Information                  .
 .                                                               .
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Definition at line 899 of file dsr-option-header.h.

Constructor & Destructor Documentation

ns3::dsr::DsrOptionRerrUnreachHeader::DsrOptionRerrUnreachHeader ( )

Constructor.

Definition at line 799 of file dsr-option-header.cc.

References ns3::dsr::DsrOptionRerrHeader::SetErrorType(), ns3::dsr::DsrOptionHeader::SetLength(), and ns3::dsr::DsrOptionHeader::SetType().

+ Here is the call graph for this function:

ns3::dsr::DsrOptionRerrUnreachHeader::~DsrOptionRerrUnreachHeader ( )
virtual

Destructor.

Definition at line 808 of file dsr-option-header.cc.

Member Function Documentation

uint32_t ns3::dsr::DsrOptionRerrUnreachHeader::Deserialize ( Buffer::Iterator  start)
virtual

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 889 of file dsr-option-header.cc.

References GetSerializedSize(), m_errorDstAddress, m_errorSrcAddress, m_originalDst, m_salvage, m_unreachNode, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU8(), ns3::dsr::DsrOptionRerrHeader::SetErrorType(), ns3::dsr::DsrOptionHeader::SetLength(), ns3::dsr::DsrOptionHeader::SetType(), and visualizer.core::start().

+ Here is the call graph for this function:

DsrOptionHeader::Alignment ns3::dsr::DsrOptionRerrUnreachHeader::GetAlignment ( ) const
virtual

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 905 of file dsr-option-header.cc.

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::GetErrorDst ( ) const
virtual

Get the error destination ip address.

Returns
The error destination address

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 837 of file dsr-option-header.cc.

References m_errorDstAddress.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRerr::Process(), ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::GetErrorSrc ( ) const
virtual

Get the route error source address.

Returns
The error source address

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 827 of file dsr-option-header.cc.

References m_errorSrcAddress.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRerr::Process(), ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

TypeId ns3::dsr::DsrOptionRerrUnreachHeader::GetInstanceTypeId ( void  ) const
virtual

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 794 of file dsr-option-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::GetOriginalDst ( ) const

Get the unreachable node ip address.

Returns
The unreachable ip address

Definition at line 857 of file dsr-option-header.cc.

References m_originalDst.

Referenced by ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

uint8_t ns3::dsr::DsrOptionRerrUnreachHeader::GetSalvage ( ) const
virtual

Get the salvage value of the packet.

Parameters
Thesalvage value of the packet

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 817 of file dsr-option-header.cc.

References m_salvage.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

uint32_t ns3::dsr::DsrOptionRerrUnreachHeader::GetSerializedSize ( void  ) const
virtual

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 870 of file dsr-option-header.cc.

Referenced by Deserialize(), and ns3::dsr::DsrOptionRerr::Process().

+ Here is the caller graph for this function:

TypeId ns3::dsr::DsrOptionRerrUnreachHeader::GetTypeId ( void  )
static

Get the type identificator.

This method returns the TypeId associated to ns3::dsr::DsrOptionRerrUnreachHeader.

Returns
type identificator

No Attributes defined for this type.
Attributes defined in parent class ns3::dsr::DsrOptionRerrHeader:

  • ErrorType: Type of route errors
    • Set with class: ns3::EnumValue
    • Underlying type: Node unreachable|Flow state not supported|Option not supported
    • Initial value: Node unreachable
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 785 of file dsr-option-header.cc.

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::GetUnreachNode ( ) const

Get the unreachable node ip address.

Returns
The unreachable ip address

Definition at line 847 of file dsr-option-header.cc.

References m_unreachNode.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRerr::Process(), ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::Print ( std::ostream &  os) const
virtual

Print some informations about the packet.

Parameters
osoutput stream
Returns
info about this packet

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 862 of file dsr-option-header.cc.

References ns3::dsr::DsrOptionHeader::GetLength(), ns3::dsr::DsrOptionHeader::GetType(), m_errorDstAddress, m_errorSrcAddress, m_errorType, m_salvage, and m_unreachNode.

+ Here is the call graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::Serialize ( Buffer::Iterator  start) const
virtual

Serialize the packet.

Parameters
startBuffer iterator

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 875 of file dsr-option-header.cc.

References ns3::dsr::DsrOptionRerrHeader::GetErrorType(), ns3::dsr::DsrOptionHeader::GetLength(), ns3::dsr::DsrOptionHeader::GetType(), m_errorDstAddress, m_errorSrcAddress, m_originalDst, m_salvage, m_unreachNode, visualizer.core::start(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::SetErrorDst ( Ipv4Address  errorDstAddress)
virtual

Set the error destination ip address.

Parameters
Theerror destination address

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 832 of file dsr-option-header.cc.

References m_errorDstAddress.

Referenced by ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::SetErrorSrc ( Ipv4Address  errorSrcAddress)
virtual

Set the route error source address.

Parameters
Theerror source address

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 822 of file dsr-option-header.cc.

References m_errorSrcAddress.

Referenced by ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::SetOriginalDst ( Ipv4Address  originalDst)

Set the unreachable node ip address.

Parameters
Theunreachable ip address

Definition at line 852 of file dsr-option-header.cc.

References m_originalDst.

Referenced by ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::SetSalvage ( uint8_t  salvage)
virtual

Set the salvage value of the packet.

Reimplemented from ns3::dsr::DsrOptionRerrHeader.

Definition at line 812 of file dsr-option-header.cc.

References m_salvage.

Referenced by ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionRerrUnreachHeader::SetUnreachNode ( Ipv4Address  unreachNode)

Set the unreachable node ip address.

Parameters
Theunreachable ip address

Definition at line 842 of file dsr-option-header.cc.

References m_unreachNode.

Referenced by ns3::dsr::DsrRerrHeaderTest::DoRun(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

Member Data Documentation

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::m_errorDstAddress
private

The error destination address.

Definition at line 1021 of file dsr-option-header.h.

Referenced by Deserialize(), GetErrorDst(), Print(), Serialize(), and SetErrorDst().

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::m_errorSrcAddress
private

The error source address.

Definition at line 1017 of file dsr-option-header.h.

Referenced by Deserialize(), GetErrorSrc(), Print(), Serialize(), and SetErrorSrc().

uint8_t ns3::dsr::DsrOptionRerrUnreachHeader::m_errorType
private

The error type or route error option.

Definition at line 1005 of file dsr-option-header.h.

Referenced by Print().

uint8_t ns3::dsr::DsrOptionRerrUnreachHeader::m_optDataLen
private

option data length

Definition at line 1001 of file dsr-option-header.h.

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::m_originalDst
private

The original destination address.

Definition at line 1029 of file dsr-option-header.h.

Referenced by Deserialize(), GetOriginalDst(), Serialize(), and SetOriginalDst().

uint8_t ns3::dsr::DsrOptionRerrUnreachHeader::m_reserved
private

The reserved field.

Definition at line 1009 of file dsr-option-header.h.

uint8_t ns3::dsr::DsrOptionRerrUnreachHeader::m_salvage
private

The salavage field.

Definition at line 1013 of file dsr-option-header.h.

Referenced by Deserialize(), GetSalvage(), Print(), Serialize(), and SetSalvage().

uint16_t ns3::dsr::DsrOptionRerrUnreachHeader::m_typeSpecific
private

The specific error type.

Definition at line 1033 of file dsr-option-header.h.

Ipv4Address ns3::dsr::DsrOptionRerrUnreachHeader::m_unreachNode
private

The unreachable node address.

Definition at line 1025 of file dsr-option-header.h.

Referenced by Deserialize(), GetUnreachNode(), Print(), Serialize(), and SetUnreachNode().

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