ns3::Ipv6OptionHeader Class Reference

Header for IPv6 Option. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::Ipv6OptionHeader:

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

Public Member Functions
	Ipv6OptionHeader ()
	Constructor.
virtual	~Ipv6OptionHeader ()
	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 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::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::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_data
	The anonymous data of this option.
uint8_t	m_length
	The option length.
uint8_t	m_type
	The type of the option.

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

Detailed Description

Header for IPv6 Option.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 35 of file ipv6-option-header.h.

Member Function Documentation

uint32_t ns3::Ipv6OptionHeader::Deserialize ( Buffer::Iterator  start )

virtual

Deserialize the packet.

Parameters

start

Buffer iterator

Returns

size of the packet

Implements ns3::Header.

Reimplemented in ns3::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionPadnHeader, and ns3::Ipv6OptionPad1Header.

Definition at line 97 of file ipv6-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(), and ns3::Buffer::Iterator::Write().

Ipv6OptionHeader::Alignment ns3::Ipv6OptionHeader::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::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, and OptionWithAlignmentHeader.

Definition at line 114 of file ipv6-option-header.cc.

Referenced by ns3::OptionField::AddOption().

TypeId ns3::Ipv6OptionHeader::GetInstanceTypeId ( void  ) const

virtual

Get the instance type ID.

Returns

instance type ID

Implements ns3::ObjectBase.

Reimplemented in ns3::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionPadnHeader, and ns3::Ipv6OptionPad1Header.

Definition at line 42 of file ipv6-option-header.cc.

References GetTypeId().

uint8_t ns3::Ipv6OptionHeader::GetLength

(

)

const

Get the option length.

Returns

the option length

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

References m_length.

Referenced by ns3::Ipv6OptionPadnHeader::GetSerializedSize(), ns3::Ipv6OptionJumbogramHeader::GetSerializedSize(), ns3::Ipv6OptionRouterAlertHeader::GetSerializedSize(), ns3::Ipv6OptionPadnHeader::Print(), ns3::Ipv6OptionJumbogramHeader::Print(), ns3::Ipv6OptionRouterAlertHeader::Print(), ns3::Ipv6OptionPadnHeader::Serialize(), ns3::Ipv6OptionJumbogramHeader::Serialize(), and ns3::Ipv6OptionRouterAlertHeader::Serialize().

uint32_t ns3::Ipv6OptionHeader::GetSerializedSize ( void  ) const

virtual

Get the serialized size of the packet.

Returns

size

Implements ns3::Header.

Reimplemented in ns3::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionPad1Header, OptionWithAlignmentHeader, and OptionWithoutAlignmentHeader.

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

References m_length.

Referenced by ns3::OptionField::AddOption(), and Deserialize().

uint8_t ns3::Ipv6OptionHeader::GetType

(

void

)

const

Get the type of the option.

Returns

the type of the option

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

References m_type.

Referenced by TestOptionWithAlignment::DoRun(), TestFulfilledAlignment::DoRun(), ns3::Ipv6OptionPad1Header::Print(), ns3::Ipv6OptionPadnHeader::Print(), ns3::Ipv6OptionJumbogramHeader::Print(), ns3::Ipv6OptionRouterAlertHeader::Print(), ns3::Ipv6OptionPad1Header::Serialize(), ns3::Ipv6OptionPadnHeader::Serialize(), ns3::Ipv6OptionJumbogramHeader::Serialize(), and ns3::Ipv6OptionRouterAlertHeader::Serialize().

TypeId ns3::Ipv6OptionHeader::GetTypeId ( void  )

static

Get the type identificator.

Returns

type identificator

Definition at line 33 of file ipv6-option-header.cc.

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

void ns3::Ipv6OptionHeader::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::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionPadnHeader, and ns3::Ipv6OptionPad1Header.

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

References m_type.

void ns3::Ipv6OptionHeader::Serialize ( Buffer::Iterator  start ) const

virtual

Serialize the packet.

Parameters

start

Buffer iterator

Implements ns3::Header.

Reimplemented in ns3::Ipv6OptionRouterAlertHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionPad1Header, OptionWithAlignmentHeader, and OptionWithoutAlignmentHeader.

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

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

Referenced by ns3::OptionField::AddOption().

void ns3::Ipv6OptionHeader::SetLength

(

uint8_t

length

)

Set the option length.

Parameters

length

the option length

Definition at line 67 of file ipv6-option-header.cc.

References m_length.

Referenced by ns3::Ipv6OptionPadnHeader::Deserialize(), ns3::Ipv6OptionJumbogramHeader::Deserialize(), ns3::Ipv6OptionRouterAlertHeader::Deserialize(), ns3::Ipv6OptionJumbogramHeader::Ipv6OptionJumbogramHeader(), ns3::Ipv6OptionPadnHeader::Ipv6OptionPadnHeader(), and ns3::Ipv6OptionRouterAlertHeader::Ipv6OptionRouterAlertHeader().

void ns3::Ipv6OptionHeader::SetType

(

uint8_t

type

)

Set the type of the option.

Parameters

type	the type of the option

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

References m_type.

Referenced by ns3::Ipv6OptionPad1Header::Deserialize(), ns3::Ipv6OptionPadnHeader::Deserialize(), ns3::Ipv6OptionJumbogramHeader::Deserialize(), ns3::Ipv6OptionRouterAlertHeader::Deserialize(), ns3::Ipv6OptionJumbogramHeader::Ipv6OptionJumbogramHeader(), ns3::Ipv6OptionPad1Header::Ipv6OptionPad1Header(), and ns3::Ipv6OptionPadnHeader::Ipv6OptionPadnHeader().

---

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

• src/internet/model/ipv6-option-header.h
• src/internet/model/ipv6-option-header.cc