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

Doxygen introspection did not find any typical Config paths. More...

#include <dsr-option-header.h>

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

Classes

struct  Alignment
 represents the alignment requirements of an option header More...
 

Public Member Functions

 DsrOptionHeader ()
 Constructor. More...
 
virtual ~DsrOptionHeader ()
 Destructor. More...
 
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 TypeId GetInstanceTypeId () const
 Get the instance type ID. More...
 
uint8_t GetLength () const
 Get the option length. More...
 
virtual uint32_t GetSerializedSize () const
 Get the serialized size of the packet. More...
 
uint8_t GetType () const
 Get the type of the option. 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...
 
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
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)
 

Static Public Member Functions

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)
 Get the type ID. More...
 

Private Attributes

Buffer m_data
 The anonymous data of this option. More...
 
uint8_t m_length
 The option length. More...
 
uint8_t m_type
 The type of the option. More...
 

Additional Inherited Members

- 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

Doxygen introspection did not find any typical Config paths.

Header for Dsr Options.


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

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

Constructor & Destructor Documentation

ns3::dsr::DsrOptionHeader::DsrOptionHeader ( )

Constructor.

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

ns3::dsr::DsrOptionHeader::~DsrOptionHeader ( )
virtual

Destructor.

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

Member Function Documentation

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

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, ns3::dsr::DsrOptionRreqHeader, ns3::dsr::DsrOptionPadnHeader, and ns3::dsr::DsrOptionPad1Header.

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

References ns3::Buffer::AddAtEnd(), ns3::Buffer::Begin(), GetSerializedSize(), m_data, m_length, m_type, ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::ReadU8(), visualizer.core::start(), and ns3::Buffer::Iterator::Write().

+ Here is the call graph for this function:

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

Get the Alignment requirement of this option header.

Returns
The required alignment

Subclasses should only implement this method, if special alignment is required. Default is no alignment (1n+0).

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, and ns3::dsr::DsrOptionRreqHeader.

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

Referenced by ns3::dsr::DsrOptionField::AddDsrOption().

+ Here is the caller graph for this function:

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

Get the instance type ID.

Returns
instance type ID

Implements ns3::ObjectBase.

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, ns3::dsr::DsrOptionRreqHeader, ns3::dsr::DsrOptionPadnHeader, and ns3::dsr::DsrOptionPad1Header.

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

References GetTypeId().

+ Here is the call graph for this function:

uint8_t ns3::dsr::DsrOptionHeader::GetLength ( ) const

Get the option length.

Returns
the option length

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

References m_length.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrOptionPadnHeader::GetSerializedSize(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionPadnHeader::Print(), ns3::dsr::DsrOptionRreqHeader::Print(), ns3::dsr::DsrOptionRrepHeader::Print(), ns3::dsr::DsrOptionSRHeader::Print(), ns3::dsr::DsrOptionRerrHeader::Print(), ns3::dsr::DsrOptionRerrUnreachHeader::Print(), ns3::dsr::DsrOptionRerrUnsupportHeader::Print(), ns3::dsr::DsrOptionAckReqHeader::Print(), ns3::dsr::DsrOptionAckHeader::Print(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), ns3::dsr::DsrRouting::SendUnreachError(), ns3::dsr::DsrOptionPadnHeader::Serialize(), ns3::dsr::DsrOptionRreqHeader::Serialize(), ns3::dsr::DsrOptionRrepHeader::Serialize(), ns3::dsr::DsrOptionSRHeader::Serialize(), ns3::dsr::DsrOptionRerrHeader::Serialize(), ns3::dsr::DsrOptionRerrUnreachHeader::Serialize(), ns3::dsr::DsrOptionRerrUnsupportHeader::Serialize(), ns3::dsr::DsrOptionAckReqHeader::Serialize(), and ns3::dsr::DsrOptionAckHeader::Serialize().

+ Here is the caller graph for this function:

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

Get the serialized size of the packet.

Returns
size

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, ns3::dsr::DsrOptionRreqHeader, ns3::dsr::DsrOptionPadnHeader, and ns3::dsr::DsrOptionPad1Header.

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

References m_length.

Referenced by ns3::dsr::DsrOptionField::AddDsrOption(), and Deserialize().

+ Here is the caller graph for this function:

uint8_t ns3::dsr::DsrOptionHeader::GetType ( ) const

Get the type of the option.

Returns
the type of the option

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

References m_type.

Referenced by ns3::dsr::DsrFsHeaderTest::DoRun(), ns3::dsr::DsrOptionPad1Header::Print(), ns3::dsr::DsrOptionPadnHeader::Print(), ns3::dsr::DsrOptionRreqHeader::Print(), ns3::dsr::DsrOptionRrepHeader::Print(), ns3::dsr::DsrOptionSRHeader::Print(), ns3::dsr::DsrOptionRerrHeader::Print(), ns3::dsr::DsrOptionRerrUnreachHeader::Print(), ns3::dsr::DsrOptionRerrUnsupportHeader::Print(), ns3::dsr::DsrOptionAckReqHeader::Print(), ns3::dsr::DsrOptionAckHeader::Print(), ns3::dsr::DsrOptionPad1Header::Serialize(), ns3::dsr::DsrOptionPadnHeader::Serialize(), ns3::dsr::DsrOptionRreqHeader::Serialize(), ns3::dsr::DsrOptionRrepHeader::Serialize(), ns3::dsr::DsrOptionSRHeader::Serialize(), ns3::dsr::DsrOptionRerrHeader::Serialize(), ns3::dsr::DsrOptionRerrUnreachHeader::Serialize(), ns3::dsr::DsrOptionRerrUnsupportHeader::Serialize(), ns3::dsr::DsrOptionAckReqHeader::Serialize(), and ns3::dsr::DsrOptionAckHeader::Serialize().

+ Here is the caller graph for this function:

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

Get the type identificator.

Returns
type identificator

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

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

Print some informations about the packet.

Parameters
osoutput stream
Returns
info about this packet

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, ns3::dsr::DsrOptionRreqHeader, ns3::dsr::DsrOptionPadnHeader, and ns3::dsr::DsrOptionPad1Header.

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

References m_length, and m_type.

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

Serialize the packet.

Parameters
startBuffer iterator

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrOptionAckHeader, ns3::dsr::DsrOptionAckReqHeader, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::dsr::DsrOptionRerrHeader, ns3::dsr::DsrOptionSRHeader, ns3::dsr::DsrOptionRrepHeader, ns3::dsr::DsrOptionRreqHeader, ns3::dsr::DsrOptionPadnHeader, and ns3::dsr::DsrOptionPad1Header.

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

References ns3::Buffer::Begin(), ns3::Buffer::End(), m_data, m_length, m_type, visualizer.core::start(), ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

Referenced by ns3::dsr::DsrOptionField::AddDsrOption().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionHeader::SetLength ( uint8_t  length)

Set the option length.

Parameters
lengththe option length

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

References m_length.

Referenced by ns3::dsr::DsrOptionRreqHeader::AddNodeAddress(), ns3::dsr::DsrOptionPadnHeader::Deserialize(), ns3::dsr::DsrOptionRreqHeader::Deserialize(), ns3::dsr::DsrOptionRrepHeader::Deserialize(), ns3::dsr::DsrOptionSRHeader::Deserialize(), ns3::dsr::DsrOptionRerrHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnreachHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnsupportHeader::Deserialize(), ns3::dsr::DsrOptionAckReqHeader::Deserialize(), ns3::dsr::DsrOptionAckHeader::Deserialize(), ns3::dsr::DsrOptionAckHeader::DsrOptionAckHeader(), ns3::dsr::DsrOptionAckReqHeader::DsrOptionAckReqHeader(), ns3::dsr::DsrOptionPadnHeader::DsrOptionPadnHeader(), ns3::dsr::DsrOptionRerrHeader::DsrOptionRerrHeader(), ns3::dsr::DsrOptionRerrUnreachHeader::DsrOptionRerrUnreachHeader(), ns3::dsr::DsrOptionRerrUnsupportHeader::DsrOptionRerrUnsupportHeader(), ns3::dsr::DsrOptionRrepHeader::DsrOptionRrepHeader(), ns3::dsr::DsrOptionRreqHeader::DsrOptionRreqHeader(), ns3::dsr::DsrOptionSRHeader::DsrOptionSRHeader(), ns3::dsr::DsrOptionRreqHeader::SetNodesAddress(), ns3::dsr::DsrOptionRrepHeader::SetNodesAddress(), and ns3::dsr::DsrOptionSRHeader::SetNodesAddress().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionHeader::SetType ( uint8_t  type)

Set the type of the option.

Parameters
typethe type of the option

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

References m_type.

Referenced by ns3::dsr::DsrOptionPad1Header::Deserialize(), ns3::dsr::DsrOptionPadnHeader::Deserialize(), ns3::dsr::DsrOptionRreqHeader::Deserialize(), ns3::dsr::DsrOptionRrepHeader::Deserialize(), ns3::dsr::DsrOptionSRHeader::Deserialize(), ns3::dsr::DsrOptionRerrHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnreachHeader::Deserialize(), ns3::dsr::DsrOptionRerrUnsupportHeader::Deserialize(), ns3::dsr::DsrOptionAckReqHeader::Deserialize(), ns3::dsr::DsrOptionAckHeader::Deserialize(), ns3::dsr::DsrOptionAckHeader::DsrOptionAckHeader(), ns3::dsr::DsrOptionAckReqHeader::DsrOptionAckReqHeader(), ns3::dsr::DsrOptionPad1Header::DsrOptionPad1Header(), ns3::dsr::DsrOptionPadnHeader::DsrOptionPadnHeader(), ns3::dsr::DsrOptionRerrHeader::DsrOptionRerrHeader(), ns3::dsr::DsrOptionRerrUnreachHeader::DsrOptionRerrUnreachHeader(), ns3::dsr::DsrOptionRerrUnsupportHeader::DsrOptionRerrUnsupportHeader(), ns3::dsr::DsrOptionRrepHeader::DsrOptionRrepHeader(), ns3::dsr::DsrOptionRreqHeader::DsrOptionRreqHeader(), and ns3::dsr::DsrOptionSRHeader::DsrOptionSRHeader().

+ Here is the caller graph for this function:

Member Data Documentation

Buffer ns3::dsr::DsrOptionHeader::m_data
private

The anonymous data of this option.

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

Referenced by Deserialize(), and Serialize().

uint8_t ns3::dsr::DsrOptionHeader::m_length
private

The option length.

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

Referenced by Deserialize(), GetLength(), GetSerializedSize(), Print(), Serialize(), and SetLength().

uint8_t ns3::dsr::DsrOptionHeader::m_type
private

The type of the option.

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

Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().

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