ns3::dsr::DsrOptionHeader Class Reference

Header for Dsr Options. More...

#include <dsr-option-header.h>

Inheritance diagram for ns3::dsr::DsrOptionHeader:

Collaboration diagram for ns3::dsr::DsrOptionHeader:

List of all members.

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

Public Member Functions
virtual TypeId	GetInstanceTypeId () const
	Get the instance type ID.
	DsrOptionHeader ()
	Constructor.
virtual	~DsrOptionHeader ()
	Destructor.
void	SetType (uint8_t type)
	Set the type of the option.
uint8_t	GetType () const
	Get the type of the option.
void	SetLength (uint8_t length)
	Set the option length.
uint8_t	GetLength () const
	Get the option length.
virtual void	Print (std::ostream &os) const
	Print some informations about the packet.
virtual uint32_t	GetSerializedSize () const
	Get the serialized size of the packet.
virtual void	Serialize (Buffer::Iterator start) const
	Serialize the packet.
virtual uint32_t	Deserialize (Buffer::Iterator start)
	Deserialize the packet.
virtual Alignment	GetAlignment () const
	Get the Alignment requirement of this option header.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type identificator.

---

Detailed Description

Header for Dsr Options.

---

Member Function Documentation

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

virtual

Deserialize the packet.

Parameters:

start

Buffer 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.

References ns3::Buffer::AddAtEnd(), ns3::Buffer::Begin(), GetSerializedSize(), ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::ReadU8(), and ns3::Buffer::Iterator::Write().

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.

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

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.

References GetTypeId().

uint8_t ns3::dsr::DsrOptionHeader::GetLength

(

)

const

Get the option length.

Returns:

the option length

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrOptionRerr::DoSendError(), 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::SendGratuitousReply(), 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().

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.

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

uint8_t ns3::dsr::DsrOptionHeader::GetType

(

)

const

Get the type of the option.

Returns:

the type of the option

Referenced by 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::DsrOptionSR::Process(), 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().

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

static

Get the type identificator.

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

Returns:

type identificator

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

Reimplemented from 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.

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

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

virtual

Print some informations about the packet.

Parameters:

os	output 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.

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

virtual

Serialize the packet.

Parameters:

start

Buffer 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.

References ns3::Buffer::Begin(), ns3::Buffer::End(), ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

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

void ns3::dsr::DsrOptionHeader::SetLength

(

uint8_t

length

)

Set the option length.

Parameters:

length

the option 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().

void ns3::dsr::DsrOptionHeader::SetType

(

uint8_t

type

)

Set the type of the option.

Parameters:

type	the type of the option

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

---

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

• src/dsr/model/dsr-option-header.h
• doc/introspected-doxygen.h
• src/dsr/model/dsr-option-header.cc