A Discrete-Event Network Simulator
API

ICMPv6 option header. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6OptionHeader:
+ Collaboration diagram for ns3::Icmpv6OptionHeader:

Public Member Functions

 Icmpv6OptionHeader ()
 Constructor. More...
 
virtual ~Icmpv6OptionHeader ()
 Destructor. More...
 
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 information. 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::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 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 erros. 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 UID of this class. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_len
 The length. More...
 
uint8_t m_type
 The type. 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

ICMPv6 option header.


Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 238 of file icmpv6-header.h.

Constructor & Destructor Documentation

◆ Icmpv6OptionHeader()

ns3::Icmpv6OptionHeader::Icmpv6OptionHeader ( )

Constructor.

Todo:

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

References m_len, m_type, and NS_LOG_FUNCTION.

◆ ~Icmpv6OptionHeader()

ns3::Icmpv6OptionHeader::~Icmpv6OptionHeader ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

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

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Implements ns3::Header.

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

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

References GetSerializedSize(), NS_LOG_FUNCTION, and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

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 1473 of file icmpv6-header.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetLength()

◆ GetSerializedSize()

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 1523 of file icmpv6-header.cc.

References m_len, and NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetType()

◆ GetTypeId()

TypeId ns3::Icmpv6OptionHeader::GetTypeId ( void  )
static

Get the UID of this class.

Returns
UID

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Print()

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

Print information.

Parameters
osoutput stream

Implements ns3::Header.

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

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

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

+ Here is the call graph for this function:

◆ Serialize()

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

Serialize the packet.

Parameters
startstart offset

Implements ns3::Header.

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

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

References NS_LOG_FUNCTION, and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetLength()

◆ SetType()

Member Data Documentation

◆ m_len

uint8_t ns3::Icmpv6OptionHeader::m_len
private

The length.

Definition at line 321 of file icmpv6-header.h.

Referenced by GetLength(), GetSerializedSize(), Icmpv6OptionHeader(), and SetLength().

◆ m_type

uint8_t ns3::Icmpv6OptionHeader::m_type
private

The type.

Definition at line 316 of file icmpv6-header.h.

Referenced by GetType(), Icmpv6OptionHeader(), and SetType().


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