A Discrete-Event Network Simulator
API
ns3::dsr::DsrOptionRerrHeader Class Reference

Header of Dsr Option Route Error. More...

#include "dsr-option-header.h"

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

Public Member Functions

 DsrOptionRerrHeader ()
 Constructor. More...
 
 ~DsrOptionRerrHeader () override
 Destructor. More...
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet. More...
 
Alignment GetAlignment () const override
 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...
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID. More...
 
virtual uint8_t GetSalvage () const
 Get the salvage value of the packet. More...
 
uint32_t GetSerializedSize () const override
 Get the serialized size of the packet. More...
 
void Print (std::ostream &os) const override
 Print some information about the packet. More...
 
void Serialize (Buffer::Iterator start) const override
 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. More...
 
- Public Member Functions inherited from ns3::dsr::DsrOptionHeader
 DsrOptionHeader ()
 Constructor. More...
 
 ~DsrOptionHeader () override
 Destructor. More...
 
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::Header
 ~Header () override
 
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...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. 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 errors. 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 ()
 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 ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

Buffer m_errorData
 The anonymous data of this option. More...
 
Ipv4Address m_errorDstAddress
 The error destination address. More...
 
uint16_t m_errorLength
 The specific error message length. More...
 
Ipv4Address m_errorSrcAddress
 The error source address. More...
 
uint8_t m_errorType
 The error type or route error option. More...
 
uint8_t m_salvage
 The salavage field. 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Header of Dsr Option Route Error.

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

Constructor & Destructor Documentation

◆ DsrOptionRerrHeader()

ns3::dsr::DsrOptionRerrHeader::DsrOptionRerrHeader ( )

Constructor.

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

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

+ Here is the call graph for this function:

◆ ~DsrOptionRerrHeader()

ns3::dsr::DsrOptionRerrHeader::~DsrOptionRerrHeader ( )
override

Destructor.

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

Member Function Documentation

◆ Deserialize()

◆ GetAlignment()

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

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::dsr::DsrOptionHeader.

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

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

◆ GetErrorDst()

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

Get the error destination ip address.

Returns
The error destination address

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

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

References m_errorDstAddress.

◆ GetErrorSrc()

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

Get the route error source address.

Returns
The error source address

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

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

References m_errorSrcAddress.

◆ GetErrorType()

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

Get the route error type.

Returns
The error type

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

References m_errorType.

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

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::dsr::DsrOptionHeader.

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

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSalvage()

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

Get the salvage value of the packet.

Returns
The salvage value of the packet

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

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

References m_salvage.

◆ GetSerializedSize()

uint32_t ns3::dsr::DsrOptionRerrHeader::GetSerializedSize ( ) const
overridevirtual

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::dsr::DsrOptionHeader.

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

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

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type identificator.

Returns
type identificator

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

◆ Print()

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

Print some information about the packet.

Parameters
osoutput stream

Reimplemented from ns3::dsr::DsrOptionHeader.

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

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

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

+ Here is the call graph for this function:

◆ Serialize()

◆ SetErrorDst()

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

Set the error destination ip address.

Parameters
errorDstAddressThe error destination address

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

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

References m_errorDstAddress.

◆ SetErrorSrc()

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

Set the route error source address.

Parameters
errorSrcAddressThe error source address

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

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

References m_errorSrcAddress.

◆ SetErrorType()

◆ SetSalvage()

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

Set the salvage value of the packet.

Parameters
salvageThe salvage value of the packet

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

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

References m_salvage.

Member Data Documentation

◆ m_errorData

Buffer ns3::dsr::DsrOptionRerrHeader::m_errorData
private

The anonymous data of this option.

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

Referenced by Deserialize(), and Serialize().

◆ m_errorDstAddress

Ipv4Address ns3::dsr::DsrOptionRerrHeader::m_errorDstAddress
private

The error destination address.

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

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

◆ m_errorLength

uint16_t ns3::dsr::DsrOptionRerrHeader::m_errorLength
private

The specific error message length.

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

Referenced by Deserialize().

◆ m_errorSrcAddress

Ipv4Address ns3::dsr::DsrOptionRerrHeader::m_errorSrcAddress
private

The error source address.

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

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

◆ m_errorType

uint8_t ns3::dsr::DsrOptionRerrHeader::m_errorType
private

The error type or route error option.

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

Referenced by Deserialize(), GetErrorType(), Print(), Serialize(), and SetErrorType().

◆ m_salvage

uint8_t ns3::dsr::DsrOptionRerrHeader::m_salvage
private

The salavage field.

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

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


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