A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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.
 
 ~Ipv6OptionRouterAlertHeader () override
 Destructor.
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet.
 
Alignment GetAlignment () const override
 Get the Alignment requirement of this option header.
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID.
 
uint32_t GetSerializedSize () const override
 Get the serialized size of the packet.
 
uint16_t GetValue () const
 Get the field "value".
 
void Print (std::ostream &os) const override
 Print some information about the packet.
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet.
 
void SetValue (uint16_t value)
 Set the field "value".
 
- Public Member Functions inherited from ns3::Ipv6OptionHeader
 Ipv6OptionHeader ()
 Constructor.
 
 ~Ipv6OptionHeader () override
 Destructor.
 
uint8_t GetLength () const
 Get the option length.
 
uint8_t GetType () const
 Get the type of the option.
 
void SetLength (uint8_t length)
 Set the option length.
 
void SetType (uint8_t type)
 Set the type of the option.
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type identificator.
 
- Static Public Member Functions inherited from ns3::Ipv6OptionHeader
static TypeId GetTypeId ()
 Get the type identificator.
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

uint16_t m_value
 The value.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

Header of IPv6 Option Router Alert.

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

Constructor & Destructor Documentation

◆ Ipv6OptionRouterAlertHeader()

ns3::Ipv6OptionRouterAlertHeader::Ipv6OptionRouterAlertHeader ( )

Constructor.

Definition at line 342 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 ( )
override

Destructor.

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

Member Function Documentation

◆ Deserialize()

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

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Reimplemented from ns3::Ipv6OptionHeader.

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

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

+ Here is the call graph for this function:

◆ GetAlignment()

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

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::Ipv6OptionHeader.

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

◆ GetInstanceTypeId()

TypeId ns3::Ipv6OptionRouterAlertHeader::GetInstanceTypeId ( ) const
overridevirtual

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Ipv6OptionHeader.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Ipv6OptionRouterAlertHeader::GetSerializedSize ( ) const
overridevirtual

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::Ipv6OptionHeader.

Definition at line 373 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 ( )
static

Get the type identificator.

Returns
type identificator

Definition at line 327 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 ( ) const

Get the field "value".

Returns
the field "value"

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

References m_value.

◆ Print()

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

Print some information about the packet.

Parameters
osoutput stream

Reimplemented from ns3::Ipv6OptionHeader.

Definition at line 366 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
overridevirtual

Serialize the packet.

Parameters
startBuffer iterator

Reimplemented from ns3::Ipv6OptionHeader.

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

References ns3::Ipv6OptionHeader::GetLength(), ns3::Ipv6OptionHeader::GetType(), m_value, 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 354 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 407 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: