ns3::Icmpv6OptionHeader Class Reference

ICMPv6 option header. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::Icmpv6OptionHeader:

Public Member Functions
	Icmpv6OptionHeader ()
	Constructor.
virtual	~Icmpv6OptionHeader ()
	Destructor.
virtual uint32_t	Deserialize (Buffer::Iterator start)
	Deserialize the packet. More...
virtual TypeId	GetInstanceTypeId () const
	Get the instance type ID. More...
uint8_t	GetLength () const
	Get the length of the option in 8 bytes unit. More...
virtual uint32_t	GetSerializedSize () const
	Get the serialized size. More...
uint8_t	GetType () const
	Get the type of the option. More...
virtual void	Print (std::ostream &os) const
	Print informations. More...
virtual void	Serialize (Buffer::Iterator start) const
	Serialize the packet. More...
void	SetLength (uint8_t len)
	Set the length of the option. 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 UID of this class. 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
uint8_t	m_len
	The length.
uint8_t	m_type
	The type.

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

Detailed Description

ICMPv6 option header.

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 241 of file icmpv6-header.h.

Member Function Documentation

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

virtual

Deserialize the packet.

Parameters

start

start offset

Returns

length of packet

Implements ns3::Header.

Reimplemented in ns3::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, and ns3::Icmpv6OptionMtu.

Definition at line 1519 of file icmpv6-header.cc.

References GetSerializedSize(), and NS_LOG_FUNCTION.

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

virtual

Get the instance type ID.

Returns

instance type ID

Implements ns3::ObjectBase.

Reimplemented in ns3::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, and ns3::Icmpv6OptionMtu.

Definition at line 1463 of file icmpv6-header.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

uint8_t ns3::Icmpv6OptionHeader::GetLength

(

)

const

Get the length of the option in 8 bytes unit.

Returns

length of the option

Definition at line 1495 of file icmpv6-header.cc.

References m_len, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6OptionLinkLayerAddress::Deserialize(), ns3::Icmpv6OptionRedirected::Deserialize(), ns3::Icmpv6OptionLinkLayerAddress::GetSerializedSize(), Print(), ns3::Icmpv6OptionMtu::Print(), ns3::Icmpv6OptionPrefixInformation::Print(), ns3::Icmpv6OptionLinkLayerAddress::Print(), ns3::Icmpv6OptionRedirected::Print(), ns3::Icmpv6OptionMtu::Serialize(), ns3::Icmpv6OptionPrefixInformation::Serialize(), ns3::Icmpv6OptionLinkLayerAddress::Serialize(), and ns3::Icmpv6OptionRedirected::Serialize().

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

virtual

Get the serialized size.

Returns

serialized size

Implements ns3::Header.

Reimplemented in ns3::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, and ns3::Icmpv6OptionMtu.

Definition at line 1513 of file icmpv6-header.cc.

References m_len, and NS_LOG_FUNCTION.

Referenced by Deserialize().

uint8_t ns3::Icmpv6OptionHeader::GetType

(

void

)

const

Get the type of the option.

Returns

type

Definition at line 1483 of file icmpv6-header.cc.

References m_type, and NS_LOG_FUNCTION_NOARGS.

Referenced by Print(), ns3::Icmpv6OptionMtu::Print(), ns3::Icmpv6OptionPrefixInformation::Print(), ns3::Icmpv6OptionLinkLayerAddress::Print(), ns3::Icmpv6OptionRedirected::Print(), ns3::Icmpv6OptionMtu::Serialize(), ns3::Icmpv6OptionPrefixInformation::Serialize(), ns3::Icmpv6OptionLinkLayerAddress::Serialize(), and ns3::Icmpv6OptionRedirected::Serialize().

TypeId ns3::Icmpv6OptionHeader::GetTypeId ( void  )

static

Get the UID of this class.

Returns

UID

Definition at line 1454 of file icmpv6-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::Icmpv6OptionHeader::Print ( std::ostream &  os ) const

virtual

Print informations.

Parameters

os	output stream

Implements ns3::Header.

Reimplemented in ns3::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, and ns3::Icmpv6OptionMtu.

Definition at line 1507 of file icmpv6-header.cc.

References GetLength(), GetType(), and NS_LOG_FUNCTION.

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

virtual

Serialize the packet.

Parameters

start

start offset

Implements ns3::Header.

Reimplemented in ns3::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, and ns3::Icmpv6OptionMtu.

Definition at line 1525 of file icmpv6-header.cc.

References NS_LOG_FUNCTION.

void ns3::Icmpv6OptionHeader::SetLength

(

uint8_t

len

)

Set the length of the option.

Parameters

len	length value to set

Definition at line 1501 of file icmpv6-header.cc.

References m_len, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6OptionMtu::Deserialize(), ns3::Icmpv6OptionPrefixInformation::Deserialize(), ns3::Icmpv6OptionLinkLayerAddress::Deserialize(), ns3::Icmpv6OptionRedirected::Deserialize(), ns3::Icmpv6OptionLinkLayerAddress::Icmpv6OptionLinkLayerAddress(), ns3::Icmpv6OptionMtu::Icmpv6OptionMtu(), ns3::Icmpv6OptionPrefixInformation::Icmpv6OptionPrefixInformation(), and ns3::Icmpv6OptionRedirected::SetPacket().

void ns3::Icmpv6OptionHeader::SetType

(

uint8_t

type

)

Set the type of the option.

Parameters

type	the type to set

Definition at line 1489 of file icmpv6-header.cc.

References m_type, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6OptionMtu::Deserialize(), ns3::Icmpv6OptionPrefixInformation::Deserialize(), ns3::Icmpv6OptionLinkLayerAddress::Deserialize(), ns3::Icmpv6OptionRedirected::Deserialize(), ns3::Icmpv6OptionLinkLayerAddress::Icmpv6OptionLinkLayerAddress(), ns3::Icmpv6OptionMtu::Icmpv6OptionMtu(), ns3::Icmpv6OptionPrefixInformation::Icmpv6OptionPrefixInformation(), and ns3::Icmpv6OptionRedirected::Icmpv6OptionRedirected().

---

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

• src/internet/model/icmpv6-header.h
• src/internet/model/icmpv6-header.cc