A Discrete-Event Network Simulator
API
ns3::Ipv6OptionHeader Class Reference

Header for IPv6 Option. More...

#include "ipv6-option-header.h"

+ Inheritance diagram for ns3::Ipv6OptionHeader:
+ Collaboration diagram for ns3::Ipv6OptionHeader:

Classes

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

Public Member Functions

 Ipv6OptionHeader ()
 Constructor. More...
 
virtual ~Ipv6OptionHeader ()
 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 information 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::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 type identificator. 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

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)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Header for IPv6 Option.

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 48 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::Ipv6OptionHeader::Ipv6OptionHeader ( )

Constructor.

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

ns3::Ipv6OptionHeader::~Ipv6OptionHeader ( )
virtual

Destructor.

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

Member Function Documentation

uint32_t ns3::Ipv6OptionHeader::Deserialize ( Buffer::Iterator  start)
virtual
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 115 of file ipv6-option-header.cc.

References NS_OBJECT_ENSURE_REGISTERED.

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

+ Here is the caller graph for this function:

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 43 of file ipv6-option-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::Ipv6OptionHeader::GetSerializedSize ( void  ) const
virtual
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(), ns3::Ipv6OptionPad1Header::GetInstanceTypeId(), ns3::Ipv6OptionPadnHeader::GetInstanceTypeId(), ns3::Ipv6OptionJumbogramHeader::GetInstanceTypeId(), and ns3::Ipv6OptionRouterAlertHeader::GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Print some information about the packet.

Parameters
osoutput stream
Returns
info about this packet

Implements ns3::Header.

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

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

References m_type.

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

Serialize the packet.

Parameters
startBuffer iterator

Implements ns3::Header.

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

Definition at line 88 of file ipv6-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::OptionField::AddOption().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::Ipv6OptionHeader::SetLength ( uint8_t  length)

Member Data Documentation

Buffer ns3::Ipv6OptionHeader::m_data
private

The anonymous data of this option.

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

Referenced by Deserialize(), and Serialize().

uint8_t ns3::Ipv6OptionHeader::m_length
private

The option length.

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

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

uint8_t ns3::Ipv6OptionHeader::m_type
private

The type of the option.

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

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


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