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

Header of IPv6 Option Router Alert. More...

#include "ipv6-option-header.h"

+ Inheritance diagram for ns3::Ipv6OptionRouterAlertHeader:
+ Collaboration diagram for ns3::Ipv6OptionRouterAlertHeader:

Public Member Functions

 Ipv6OptionRouterAlertHeader ()
 Constructor. More...
 
virtual ~Ipv6OptionRouterAlertHeader ()
 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...
 
virtual uint32_t GetSerializedSize () const
 Get the serialized size of the packet. More...
 
uint16_t GetValue () const
 Get the field "value". 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 SetValue (uint16_t value)
 Set the field "value". More...
 
- Public Member Functions inherited from ns3::Ipv6OptionHeader
 Ipv6OptionHeader ()
 Constructor. More...
 
virtual ~Ipv6OptionHeader ()
 Destructor. More...
 
uint8_t GetLength () const
 Get the option length. More...
 
uint8_t GetType () const
 Get the type of the option. 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 ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 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 type identificator. More...
 
- Static Public Member Functions inherited from ns3::Ipv6OptionHeader
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

uint16_t m_value
 The value. 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 of IPv6 Option Router Alert.

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

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

Constructor & Destructor Documentation

◆ Ipv6OptionRouterAlertHeader()

ns3::Ipv6OptionRouterAlertHeader::Ipv6OptionRouterAlertHeader ( )

Constructor.

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

References ns3::Ipv6OptionHeader::SetLength(), and ns3::Ipv6OptionHeader::SetType().

+ Here is the call graph for this function:

◆ ~Ipv6OptionRouterAlertHeader()

ns3::Ipv6OptionRouterAlertHeader::~Ipv6OptionRouterAlertHeader ( )
virtual

Destructor.

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

Member Function Documentation

◆ Deserialize()

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

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Reimplemented from ns3::Ipv6OptionHeader.

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

References GetSerializedSize(), m_value, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Ipv6OptionHeader::SetLength(), ns3::Ipv6OptionHeader::SetType(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetAlignment()

Ipv6OptionHeader::Alignment ns3::Ipv6OptionRouterAlertHeader::GetAlignment ( ) const
virtual

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::Ipv6OptionHeader.

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

◆ GetInstanceTypeId()

TypeId ns3::Ipv6OptionRouterAlertHeader::GetInstanceTypeId ( void  ) const
virtual

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Ipv6OptionHeader.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Ipv6OptionRouterAlertHeader::GetSerializedSize ( void  ) const
virtual

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::Ipv6OptionHeader.

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

References ns3::Ipv6OptionHeader::GetLength().

Referenced by Deserialize(), and ns3::Ipv6OptionRouterAlert::Process().

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

◆ GetTypeId()

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

Get the type identificator.

Returns
type identificator

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

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

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

◆ GetValue()

uint16_t ns3::Ipv6OptionRouterAlertHeader::GetValue ( void  ) const

Get the field "value".

Returns
the field "value"

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

References m_value.

◆ Print()

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

Print some information about the packet.

Parameters
osoutput stream

Reimplemented from ns3::Ipv6OptionHeader.

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

References ns3::Ipv6OptionHeader::GetLength(), ns3::Ipv6OptionHeader::GetType(), and m_value.

+ Here is the call graph for this function:

◆ Serialize()

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

Serialize the packet.

Parameters
startBuffer iterator

Reimplemented from ns3::Ipv6OptionHeader.

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

References ns3::Ipv6OptionHeader::GetLength(), ns3::Ipv6OptionHeader::GetType(), m_value, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetValue()

void ns3::Ipv6OptionRouterAlertHeader::SetValue ( uint16_t  value)

Set the field "value".

Parameters
valuethe value to be set.

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

References m_value.

Member Data Documentation

◆ m_value

uint16_t ns3::Ipv6OptionRouterAlertHeader::m_value
private

The value.

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

Referenced by Deserialize(), GetValue(), Print(), Serialize(), and SetValue().


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