A Discrete-Event Network Simulator
API

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...
 
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...
 
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 ()
 
- 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...
 
uint8_t m_flags
 The flags field value. 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...
 

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

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(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

ns3::Icmpv6RA::~Icmpv6RA ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::Icmpv6RA::Deserialize ( Buffer::Iterator  start)
virtual
uint8_t ns3::Icmpv6RA::GetCurHopLimit ( ) const

Get the IPv6 maximum number of jumps.

Returns
maximum jumps

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

References NS_LOG_FUNCTION.

bool ns3::Icmpv6RA::GetFlagH ( ) const

Get the H flag.

Returns
H flag

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

References NS_LOG_FUNCTION.

bool ns3::Icmpv6RA::GetFlagM ( ) const

Get the M flag.

Returns
M flag

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

References NS_LOG_FUNCTION.

bool ns3::Icmpv6RA::GetFlagO ( ) const

Get the O flag.

Returns
O flag

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

References NS_LOG_FUNCTION.

uint8_t ns3::Icmpv6RA::GetFlags ( ) const

Getflags.

Returns
the flags value

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

References NS_LOG_FUNCTION.

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 ns3::Icmpv6Header::GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

uint16_t ns3::Icmpv6RA::GetLifeTime ( ) const

Get the node Life time (Neighbor Discovery).

Returns
life time

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

uint32_t ns3::Icmpv6RA::GetReachableTime ( ) const

Get the node Reachable time (Neighbor Discovery).

Returns
reachable time

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

References NS_LOG_FUNCTION.

uint32_t ns3::Icmpv6RA::GetRetransmissionTime ( ) const

Get the node Retransmission time (Neighbor Discovery).

Returns
retransmission time

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

References NS_LOG_FUNCTION.

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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().

+ Here is the call graph for this function:

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

Print information.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

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

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

Set the IPv6 maximum number of jumps.

Parameters
mmaximum jumps

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the H flag.

Parameters
hvalue

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the M flag.

Parameters
mvalue

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the O flag.

Parameters
ovalue

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Setflags.

Parameters
fthe flags value

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

References f(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

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

Set the node Life time (Neighbor Discovery).

Parameters
llife time

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the node Reachable time (Neighbor Discovery).

Parameters
rReachable time

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the node Retransmission time (Neighbor Discovery).

Parameters
rRetransmission time

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

References NS_LOG_FUNCTION.

Referenced by ns3::Radvd::Send().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::Icmpv6RA::m_curHopLimit
private

The max jumps.

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

bool ns3::Icmpv6RA::m_flagH
private

The H flag.

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

bool ns3::Icmpv6RA::m_flagM
private

The M flag.

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

bool ns3::Icmpv6RA::m_flagO
private

The O flag.

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

uint8_t ns3::Icmpv6RA::m_flags
private

The flags field value.

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

uint16_t ns3::Icmpv6RA::m_LifeTime
private

The lifetime value.

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

uint32_t ns3::Icmpv6RA::m_ReachableTime
private

The reachable time value.

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

uint32_t ns3::Icmpv6RA::m_RetransmissionTimer
private

The retransmission timer.

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


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