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

Header of Dsr Option Route Error. More...

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::dsr::DsrOptionRerrHeader:

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

Buffer m_errorData
 The anonymous data of this option.
 
Ipv4Address m_errorDstAddress
 The error destination address.
 
uint16_t m_errorLength
 The specific error message length.
 
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
 
uint8_t m_reserved
 The reserved field.
 
uint8_t m_salvage
 The salavage field.
 

Additional Inherited Members

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

Detailed Description

Header of Dsr Option Route Error.

Doxygen introspection did not find any typical Config paths.

Attributes

  • 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 are defined for this type.

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

Member Function Documentation

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

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References ns3::Buffer::AddAtEnd(), ns3::Buffer::Begin(), GetSerializedSize(), m_errorData, m_errorDstAddress, m_errorLength, m_errorSrcAddress, m_errorType, m_salvage, ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::ReadU8(), ns3::dsr::DsrOptionHeader::SetLength(), ns3::dsr::DsrOptionHeader::SetType(), and ns3::Buffer::Iterator::Write().

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

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

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

Get the error destination ip address.

Returns
The error destination address

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References m_errorDstAddress.

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

Get the route error source address.

Returns
The error source address

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References m_errorSrcAddress.

uint8_t ns3::dsr::DsrOptionRerrHeader::GetErrorType ( ) const

Get the route error type.

Returns
The error type

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

References m_errorType.

Referenced by ns3::dsr::DsrOptionRerrUnreachHeader::Serialize(), and ns3::dsr::DsrOptionRerrUnsupportHeader::Serialize().

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References GetTypeId().

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

Get the salvage value of the packet.

Parameters
Thesalvage value of the packet

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References m_salvage.

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

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

Referenced by Deserialize().

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

Get the type identificator.

Returns
type identificator

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

References ns3::TypeId::AddConstructor(), and m_errorType.

Referenced by GetInstanceTypeId().

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

Print some informations about the packet.

Parameters
osoutput stream
Returns
info about this packet

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

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

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

Serialize the packet.

Parameters
startBuffer iterator

Reimplemented from ns3::dsr::DsrOptionHeader.

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References ns3::Buffer::Begin(), ns3::Buffer::End(), ns3::dsr::DsrOptionHeader::GetLength(), ns3::dsr::DsrOptionHeader::GetType(), m_errorData, m_errorDstAddress, m_errorSrcAddress, m_errorType, m_salvage, ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

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

Set the error destination ip address.

Parameters
Theerror destination address

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References m_errorDstAddress.

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

Set the route error source address.

Parameters
Theerror source address

Reimplemented in ns3::dsr::DsrOptionRerrUnsupportHeader, and ns3::dsr::DsrOptionRerrUnreachHeader.

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

References m_errorSrcAddress.

void ns3::dsr::DsrOptionRerrHeader::SetErrorType ( uint8_t  errorType)

Set the route error type.

Parameters
Theerror type

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

References m_errorType.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrOptionRerrUnreachHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnsupportHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnreachHeader::DsrOptionRerrUnreachHeader(), ns3::dsr::DsrOptionRerrUnsupportHeader::DsrOptionRerrUnsupportHeader(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrRouting::Receive(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

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