A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Icmpv6RA Class Reference

ICMPv6 Router Advertisement header. More...

#include <icmpv6-header.h>

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

Public Member Functions

 Icmpv6RA ()
 Constructor.
virtual ~Icmpv6RA ()
 Destructor.
virtual uint32_t Deserialize (Buffer::Iterator start)
 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.
uint8_t GetFlags () const
 Getflags.
virtual TypeId GetInstanceTypeId () const
 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).
virtual uint32_t GetSerializedSize () const
 Get the serialized size.
virtual void Print (std::ostream &os) const
 Print informations.
virtual void Serialize (Buffer::Iterator start) const
 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 SetFlags (uint8_t f)
 Setflags.
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.
virtual ~Icmpv6Header ()
 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
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId ()
 Get the UID of this class.

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

This type is not accessible from the Config system.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::Icmpv6RA::~Icmpv6RA ( )
virtual

Destructor.

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

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 476 of file icmpv6-header.cc.

References m_curHopLimit.

bool ns3::Icmpv6RA::GetFlagH ( ) const

Get the H flag.

Returns
H flag

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

References m_flagH.

bool ns3::Icmpv6RA::GetFlagM ( ) const

Get the M flag.

Returns
M flag

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

References m_flagM.

bool ns3::Icmpv6RA::GetFlagO ( ) const

Get the O flag.

Returns
O flag

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

References m_flagO.

uint8_t ns3::Icmpv6RA::GetFlags ( ) const

Getflags.

Returns
the flags value

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

References m_flags.

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6Header.

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

References GetTypeId().

+ 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 481 of file icmpv6-header.cc.

References m_LifeTime.

Referenced by Serialize().

+ 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 486 of file icmpv6-header.cc.

References m_ReachableTime.

Referenced by Serialize().

+ Here is the caller graph for this function:

uint32_t ns3::Icmpv6RA::GetRetransmissionTime ( ) const

Get the node Retransmission time (Neighbor Discovery).

Returns
retransmission time

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

References m_RetransmissionTimer.

Referenced by Serialize().

+ Here is the caller graph for this function:

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

Get the UID of this class.

Returns
UID

Reimplemented from ns3::Icmpv6Header.

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

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

Print informations.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

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

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

+ 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 471 of file icmpv6-header.cc.

References m_curHopLimit.

Referenced by Deserialize(), and Icmpv6RA().

+ Here is the caller graph for this function:

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

Set the H flag.

Parameters
hvalue

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

References m_flagH.

Referenced by Icmpv6RA().

+ Here is the caller graph for this function:

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

Set the M flag.

Parameters
mvalue

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

References m_flagM.

Referenced by Icmpv6RA().

+ Here is the caller graph for this function:

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

Set the O flag.

Parameters
ovalue

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

References m_flagO.

Referenced by Icmpv6RA().

+ Here is the caller graph for this function:

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

Setflags.

Parameters
fthe flags value

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

References m_flags.

Referenced by Icmpv6RA().

+ Here is the caller graph for this function:

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

Set the node Life time (Neighbor Discovery).

Parameters
llife time

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

References m_LifeTime.

Referenced by Deserialize(), and Icmpv6RA().

+ 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 501 of file icmpv6-header.cc.

References m_ReachableTime.

Referenced by Deserialize(), and Icmpv6RA().

+ 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 506 of file icmpv6-header.cc.

References m_RetransmissionTimer.

Referenced by Deserialize(), and Icmpv6RA().

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

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

bool ns3::Icmpv6RA::m_flagH
private

The H flag.

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

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

bool ns3::Icmpv6RA::m_flagM
private

The M flag.

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

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

bool ns3::Icmpv6RA::m_flagO
private

The O flag.

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

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

uint8_t ns3::Icmpv6RA::m_flags
private

The flags field value.

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

Referenced by Deserialize(), GetFlags(), and SetFlags().

uint16_t ns3::Icmpv6RA::m_LifeTime
private

The lifetime value.

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

Referenced by GetLifeTime(), and SetLifeTime().

uint32_t ns3::Icmpv6RA::m_ReachableTime
private

The reachable time value.

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

Referenced by GetReachableTime(), and SetReachableTime().

uint32_t ns3::Icmpv6RA::m_RetransmissionTimer
private

The retransmission timer.

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

Referenced by GetRetransmissionTime(), and SetRetransmissionTime().


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