A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches

ICMPv6 Router Advertisement header. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6RA:
+ Collaboration diagram for ns3::Icmpv6RA:

Public Member Functions

 Icmpv6RA ()
 Constructor.
 
 ~Icmpv6RA () override
 Destructor.
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet.
 
uint8_t GetCurHopLimit () const
 Get the IPv6 maximum number of jumps.
 
bool GetFlagH () const
 Get the H flag.
 
bool GetFlagM () const
 Get the M flag.
 
bool GetFlagO () const
 Get the O flag.
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID.
 
uint16_t GetLifeTime () const
 Get the node Life time (Neighbor Discovery).
 
uint32_t GetReachableTime () const
 Get the node Reachable time (Neighbor Discovery).
 
uint32_t GetRetransmissionTime () const
 Get the node Retransmission time (Neighbor Discovery).
 
uint32_t GetSerializedSize () const override
 Get the serialized size.
 
void Print (std::ostream &os) const override
 Print information.
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet.
 
void SetCurHopLimit (uint8_t m)
 Set the IPv6 maximum number of jumps.
 
void SetFlagH (bool h)
 Set the H flag.
 
void SetFlagM (bool m)
 Set the M flag.
 
void SetFlagO (bool o)
 Set the O flag.
 
void SetLifeTime (uint16_t l)
 Set the node Life time (Neighbor Discovery).
 
void SetReachableTime (uint32_t r)
 Set the node Reachable time (Neighbor Discovery).
 
void SetRetransmissionTime (uint32_t r)
 Set the node Retransmission time (Neighbor Discovery).
 
- Public Member Functions inherited from ns3::Icmpv6Header
 Icmpv6Header ()
 Constructor.
 
 ~Icmpv6Header () override
 Destructor.
 
void CalculatePseudoHeaderChecksum (Ipv6Address src, Ipv6Address dst, uint16_t length, uint8_t protocol)
 Calculate pseudo header checksum for IPv6.
 
uint16_t GetChecksum () const
 Get the checksum.
 
uint8_t GetCode () const
 Get the code field.
 
uint8_t GetType () const
 Get the type field.
 
void SetChecksum (uint16_t checksum)
 Set the checksum.
 
void SetCode (uint8_t code)
 Set the code field.
 
void SetType (uint8_t type)
 Set the type.
 
- 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 UID of this class.
 
- Static Public Member Functions inherited from ns3::Icmpv6Header
static TypeId GetTypeId ()
 Get the UID of this class.
 
- 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

uint8_t m_curHopLimit
 The max jumps.
 
bool m_flagH
 The H flag.
 
bool m_flagM
 The M flag.
 
bool m_flagO
 The O flag.
 
uint16_t m_LifeTime
 The lifetime value.
 
uint32_t m_ReachableTime
 The reachable time value.
 
uint32_t m_RetransmissionTimer
 The retransmission timer.
 

Additional Inherited Members

- Public Types inherited from ns3::Icmpv6Header
enum  ErrorDestinationUnreachable_e {
  ICMPV6_NO_ROUTE = 0 , ICMPV6_ADM_PROHIBITED , ICMPV6_NOT_NEIGHBOUR , ICMPV6_ADDR_UNREACHABLE ,
  ICMPV6_PORT_UNREACHABLE
}
 ICMPv6 error code : Destination Unreachable. More...
 
enum  ErrorParameterError_e { ICMPV6_MALFORMED_HEADER = 0 , ICMPV6_UNKNOWN_NEXT_HEADER , ICMPV6_UNKNOWN_OPTION }
 ICMPv6 error code : Parameter Error. More...
 
enum  ErrorTimeExceeded_e { ICMPV6_HOPLIMIT = 0 , ICMPV6_FRAGTIME }
 ICMPv6 error code : Time Exceeded. More...
 
enum  OptionType_e {
  ICMPV6_OPT_LINK_LAYER_SOURCE = 1 , ICMPV6_OPT_LINK_LAYER_TARGET , ICMPV6_OPT_PREFIX , ICMPV6_OPT_REDIRECTED ,
  ICMPV6_OPT_MTU
}
 ICMPv6 Option type code. More...
 
enum  Type_e {
  ICMPV6_ERROR_DESTINATION_UNREACHABLE = 1 , ICMPV6_ERROR_PACKET_TOO_BIG , ICMPV6_ERROR_TIME_EXCEEDED , ICMPV6_ERROR_PARAMETER_ERROR ,
  ICMPV6_ECHO_REQUEST = 128 , ICMPV6_ECHO_REPLY , ICMPV6_SUBSCRIBE_REQUEST , ICMPV6_SUBSCRIBE_REPORT ,
  ICMPV6_SUBSCRIVE_END , ICMPV6_ND_ROUTER_SOLICITATION , ICMPV6_ND_ROUTER_ADVERTISEMENT , ICMPV6_ND_NEIGHBOR_SOLICITATION ,
  ICMPV6_ND_NEIGHBOR_ADVERTISEMENT , ICMPV6_ND_REDIRECTION , ICMPV6_ROUTER_RENUMBER , ICMPV6_INFORMATION_REQUEST ,
  ICMPV6_INFORMATION_RESPONSE , ICMPV6_INVERSE_ND_SOLICITATION , ICMPV6_INVERSE_ND_ADVERSTISEMENT , ICMPV6_MLDV2_SUBSCRIBE_REPORT ,
  ICMPV6_MOBILITY_HA_DISCOVER_REQUEST , ICMPV6_MOBILITY_HA_DISCOVER_RESPONSE , ICMPV6_MOBILITY_MOBILE_PREFIX_SOLICITATION , ICMPV6_SECURE_ND_CERTIFICATE_PATH_SOLICITATION ,
  ICMPV6_SECURE_ND_CERTIFICATE_PATH_ADVERTISEMENT , ICMPV6_EXPERIMENTAL_MOBILITY
}
 ICMPv6 type code. More...
 
- 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.
 
- Protected Attributes inherited from ns3::Icmpv6Header
bool m_calcChecksum
 Checksum enable or not.
 
uint16_t m_checksum
 The checksum.
 

Detailed Description

ICMPv6 Router Advertisement header.

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

Constructor & Destructor Documentation

◆ Icmpv6RA()

ns3::Icmpv6RA::Icmpv6RA ( )

Constructor.

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

References ns3::Icmpv6Header::ICMPV6_ND_ROUTER_ADVERTISEMENT, NS_LOG_FUNCTION, ns3::Icmpv6Header::SetCode(), SetCurHopLimit(), SetFlagH(), SetFlagM(), SetFlagO(), SetLifeTime(), SetReachableTime(), SetRetransmissionTime(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

◆ ~Icmpv6RA()

ns3::Icmpv6RA::~Icmpv6RA ( )
override

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

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

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Reimplemented from ns3::Icmpv6Header.

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

References GetSerializedSize(), ns3::Icmpv6Header::m_checksum, m_flagH, m_flagM, m_flagO, NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Icmpv6Header::SetCode(), SetCurHopLimit(), SetLifeTime(), SetReachableTime(), SetRetransmissionTime(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

◆ GetCurHopLimit()

uint8_t ns3::Icmpv6RA::GetCurHopLimit ( ) const

Get the IPv6 maximum number of jumps.

Returns
maximum jumps

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

References m_curHopLimit, and NS_LOG_FUNCTION.

◆ GetFlagH()

bool ns3::Icmpv6RA::GetFlagH ( ) const

Get the H flag.

Returns
H flag

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

References m_flagH, and NS_LOG_FUNCTION.

◆ GetFlagM()

bool ns3::Icmpv6RA::GetFlagM ( ) const

Get the M flag.

Returns
M flag

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

References m_flagM, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleRA().

+ Here is the caller graph for this function:

◆ GetFlagO()

bool ns3::Icmpv6RA::GetFlagO ( ) const

Get the O flag.

Returns
O flag

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

References m_flagO, and NS_LOG_FUNCTION.

◆ GetInstanceTypeId()

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6Header.

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

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetLifeTime()

uint16_t ns3::Icmpv6RA::GetLifeTime ( ) const

Get the node Life time (Neighbor Discovery).

Returns
life time

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

References m_LifeTime, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleRA(), and Serialize().

+ Here is the caller graph for this function:

◆ GetReachableTime()

uint32_t ns3::Icmpv6RA::GetReachableTime ( ) const

Get the node Reachable time (Neighbor Discovery).

Returns
reachable time

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

References m_ReachableTime, and NS_LOG_FUNCTION.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetRetransmissionTime()

uint32_t ns3::Icmpv6RA::GetRetransmissionTime ( ) const

Get the node Retransmission time (Neighbor Discovery).

Returns
retransmission time

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

References m_RetransmissionTimer, and NS_LOG_FUNCTION.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

References NS_LOG_FUNCTION.

Referenced by Deserialize(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Icmpv6RA::GetTypeId ( )
static

Get the UID of this class.

Returns
UID

Definition at line 516 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::Icmpv6RA::Print ( std::ostream & os) const
overridevirtual

Print information.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

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

References ns3::Icmpv6Header::GetChecksum(), ns3::Icmpv6Header::GetCode(), ns3::Icmpv6Header::GetType(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::Icmpv6RA::Serialize ( Buffer::Iterator start) const
overridevirtual

◆ SetCurHopLimit()

void ns3::Icmpv6RA::SetCurHopLimit ( uint8_t m)

Set the IPv6 maximum number of jumps.

Parameters
mmaximum jumps

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

References m_curHopLimit, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), Deserialize(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetFlagH()

void ns3::Icmpv6RA::SetFlagH ( bool h)

Set the H flag.

Parameters
hvalue

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

References m_flagH, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetFlagM()

void ns3::Icmpv6RA::SetFlagM ( bool m)

Set the M flag.

Parameters
mvalue

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

References m_flagM, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetFlagO()

void ns3::Icmpv6RA::SetFlagO ( bool o)

Set the O flag.

Parameters
ovalue

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

References m_flagO, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetLifeTime()

void ns3::Icmpv6RA::SetLifeTime ( uint16_t l)

Set the node Life time (Neighbor Discovery).

Parameters
llife time

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

References m_LifeTime, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), Deserialize(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetReachableTime()

void ns3::Icmpv6RA::SetReachableTime ( uint32_t r)

Set the node Reachable time (Neighbor Discovery).

Parameters
rReachable time

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

References m_ReachableTime, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), Deserialize(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

◆ SetRetransmissionTime()

void ns3::Icmpv6RA::SetRetransmissionTime ( uint32_t r)

Set the node Retransmission time (Neighbor Discovery).

Parameters
rRetransmission time

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

References m_RetransmissionTimer, and NS_LOG_FUNCTION.

Referenced by Icmpv6RA(), Deserialize(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_curHopLimit

uint8_t ns3::Icmpv6RA::m_curHopLimit
private

The max jumps.

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

Referenced by GetCurHopLimit(), Serialize(), and SetCurHopLimit().

◆ m_flagH

bool ns3::Icmpv6RA::m_flagH
private

The H flag.

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

Referenced by Deserialize(), GetFlagH(), Serialize(), and SetFlagH().

◆ m_flagM

bool ns3::Icmpv6RA::m_flagM
private

The M flag.

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

Referenced by Deserialize(), GetFlagM(), Serialize(), and SetFlagM().

◆ m_flagO

bool ns3::Icmpv6RA::m_flagO
private

The O flag.

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

Referenced by Deserialize(), GetFlagO(), Serialize(), and SetFlagO().

◆ m_LifeTime

uint16_t ns3::Icmpv6RA::m_LifeTime
private

The lifetime value.

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

Referenced by GetLifeTime(), and SetLifeTime().

◆ m_ReachableTime

uint32_t ns3::Icmpv6RA::m_ReachableTime
private

The reachable time value.

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

Referenced by GetReachableTime(), and SetReachableTime().

◆ m_RetransmissionTimer

uint32_t ns3::Icmpv6RA::m_RetransmissionTimer
private

The retransmission timer.

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

Referenced by GetRetransmissionTime(), and SetRetransmissionTime().


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