ICMPv6 Router Advertisement header. More...

#include "icmpv6-header.h"

Inheritance diagram for ns3::Icmpv6RA:

Collaboration diagram for ns3::Icmpv6RA:

Public Member Functions
	Icmpv6RA ()
	Constructor. More...

virtual	~Icmpv6RA ()
	Destructor. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)
	Deserialize the packet. More...

uint8_t	GetCurHopLimit () const
	Get the IPv6 maximum number of jumps. More...

bool	GetFlagH () const
	Get the H flag. More...

bool	GetFlagM () const
	Get the M flag. More...

bool	GetFlagO () const
	Get the O flag. More...

NS_DEPRECATED_3_34 uint8_t	GetFlags () const
	Getflags. More...

virtual TypeId	GetInstanceTypeId () const
	Get the instance type ID. More...

uint16_t	GetLifeTime () const
	Get the node Life time (Neighbor Discovery). More...

uint32_t	GetReachableTime () const
	Get the node Reachable time (Neighbor Discovery). More...

uint32_t	GetRetransmissionTime () const
	Get the node Retransmission time (Neighbor Discovery). More...

virtual uint32_t	GetSerializedSize () const
	Get the serialized size. More...

virtual void	Print (std::ostream &os) const
	Print information. More...

virtual void	Serialize (Buffer::Iterator start) const
	Serialize the packet. More...

void	SetCurHopLimit (uint8_t m)
	Set the IPv6 maximum number of jumps. More...

void	SetFlagH (bool h)
	Set the H flag. More...

void	SetFlagM (bool m)
	Set the M flag. More...

void	SetFlagO (bool o)
	Set the O flag. More...

NS_DEPRECATED_3_34 void	SetFlags (uint8_t f)
	Setflags. More...

void	SetLifeTime (uint16_t l)
	Set the node Life time (Neighbor Discovery). More...

void	SetReachableTime (uint32_t r)
	Set the node Reachable time (Neighbor Discovery). More...

void	SetRetransmissionTime (uint32_t r)
	Set the node Retransmission time (Neighbor Discovery). More...

Public Member Functions inherited from ns3::Icmpv6Header
	Icmpv6Header ()
	Constructor. More...

virtual	~Icmpv6Header ()
	Destructor. More...

void	CalculatePseudoHeaderChecksum (Ipv6Address src, Ipv6Address dst, uint16_t length, uint8_t protocol)
	Calculate pseudo header checksum for IPv6. More...

uint16_t	GetChecksum () const
	Get the checksum. More...

uint8_t	GetCode () const
	Get the code field. More...

uint8_t	GetType () const
	Get the type field. More...

void	SetChecksum (uint16_t checksum)
	Set the checksum. More...

void	SetCode (uint8_t code)
	Set the code field. More...

void	SetType (uint8_t type)
	Set the type. 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 UID of this class. More...

Static Public Member Functions inherited from ns3::Icmpv6Header
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_curHopLimit
	The max jumps. More...

bool	m_flagH
	The H flag. More...

bool	m_flagM
	The M flag. More...

bool	m_flagO
	The O flag. More...

uint16_t	m_LifeTime
	The lifetime value. More...

uint32_t	m_ReachableTime
	The reachable time value. More...

uint32_t	m_RetransmissionTimer
	The retransmission timer. More...

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. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Protected Attributes inherited from ns3::Icmpv6Header
bool	m_calcChecksum
	Checksum enable or not. More...

uint16_t	m_checksum
	The checksum. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

ICMPv6 Router Advertisement 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 32 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ Icmpv6RA()

ns3::Icmpv6RA::Icmpv6RA ( )

Constructor.

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

virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

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

virtual

Deserialize the packet.

Parameters

start start offset

Returns: length of packet

Reimplemented from ns3::Icmpv6Header.

Definition at line 666 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(), ns3::Icmpv6Header::SetType(), and visualizer.core::start().

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 526 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 592 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 568 of file icmpv6-header.cc.

References m_flagM, and NS_LOG_FUNCTION.

◆ GetFlagO()

bool ns3::Icmpv6RA::GetFlagO ( ) const

Get the O flag.

Returns: O flag

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

References m_flagO, and NS_LOG_FUNCTION.

◆ GetFlags()

uint8_t ns3::Icmpv6RA::GetFlags ( ) const

Getflags.

Returns: the flags value

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

References NS_LOG_FUNCTION.

◆ GetInstanceTypeId()

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

virtual

Get the instance type ID.

Returns: instance type ID

Reimplemented from ns3::Icmpv6Header.

Definition at line 495 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 532 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 538 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 544 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 ( void ) const

virtual

Get the serialized size.

Returns: serialized size

Reimplemented from ns3::Icmpv6Header.

Definition at line 621 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 ( void )

static

Get the UID of this class.

Returns: UID

Definition at line 485 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

virtual

Print information.

Parameters

os	output stream

Reimplemented from ns3::Icmpv6Header.

Definition at line 615 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

virtual

Serialize the packet.

Parameters

start start offset

Reimplemented from ns3::Icmpv6Header.

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

References ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Icmpv6Header::GetChecksum(), ns3::Icmpv6Header::GetCode(), GetLifeTime(), GetReachableTime(), GetRetransmissionTime(), ns3::Buffer::Iterator::GetSize(), ns3::Icmpv6Header::GetType(), m_curHopLimit, m_flagH, m_flagM, m_flagO, ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetCurHopLimit()

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

Set the IPv6 maximum number of jumps.

Parameters

m	maximum jumps

Definition at line 520 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

h value

Definition at line 598 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

m value

Definition at line 574 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

o value

Definition at line 586 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:

◆ SetFlags()

void ns3::Icmpv6RA::SetFlags ( uint8_t f )

Setflags.

Parameters

f	the flags value

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

References f(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetLifeTime()

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

Set the node Life time (Neighbor Discovery).

Parameters

l life time

Definition at line 550 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

r	Reachable time

Definition at line 556 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

r	Retransmission time

Definition at line 562 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 751 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 731 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 721 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 726 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 736 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 741 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 746 of file icmpv6-header.h.

Referenced by GetRetransmissionTime(), and SetRetransmissionTime().

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

src/internet/model/icmpv6-header.h
src/internet/model/icmpv6-header.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Icmpv6RA()

◆ ~Icmpv6RA()

Member Function Documentation

◆ Deserialize()

◆ GetCurHopLimit()

◆ GetFlagH()

◆ GetFlagM()

◆ GetFlagO()

◆ GetFlags()

◆ GetInstanceTypeId()

◆ GetLifeTime()

◆ GetReachableTime()

◆ GetRetransmissionTime()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetCurHopLimit()

◆ SetFlagH()

◆ SetFlagM()

◆ SetFlagO()

◆ SetFlags()

◆ SetLifeTime()

◆ SetReachableTime()

◆ SetRetransmissionTime()

Member Data Documentation

◆ m_curHopLimit

◆ m_flagH

◆ m_flagM

◆ m_flagO

◆ m_LifeTime

◆ m_ReachableTime

◆ m_RetransmissionTimer