A Discrete-Event Network Simulator
API

ICMPv6 Neighbor Advertisement header. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6NA:
+ Collaboration diagram for ns3::Icmpv6NA:

Public Member Functions

 Icmpv6NA ()
 Constructor. More...
 
virtual ~Icmpv6NA ()
 Destructor. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet. More...
 
bool GetFlagO () const
 Get the O flag. More...
 
bool GetFlagR () const
 Get the R flag. More...
 
bool GetFlagS () const
 Get the S flag. More...
 
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID. More...
 
Ipv6Address GetIpv6Target () const
 Get the IPv6 target field. More...
 
uint32_t GetReserved () const
 Get the reserved field. 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 SetFlagO (bool o)
 Set the O flag. More...
 
void SetFlagR (bool r)
 Set the R flag. More...
 
void SetFlagS (bool s)
 Set the S flag. More...
 
void SetIpv6Target (Ipv6Address target)
 Set the IPv6 target field. More...
 
void SetReserved (uint32_t reserved)
 Set the reserved field. 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

bool m_flagO
 The M flag. More...
 
bool m_flagR
 The R flag. More...
 
bool m_flagS
 The O flag. More...
 
uint32_t m_reserved
 The reserved value. More...
 
Ipv6Address m_target
 The IPv6 target address. 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 Neighbor 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 40 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::Icmpv6NA::Icmpv6NA ( )
ns3::Icmpv6NA::~Icmpv6NA ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::Icmpv6NA::Deserialize ( Buffer::Iterator  start)
virtual
bool ns3::Icmpv6NA::GetFlagO ( ) const

Get the O flag.

Returns
O flag

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

bool ns3::Icmpv6NA::GetFlagR ( ) const

Get the R flag.

Returns
R flag

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

bool ns3::Icmpv6NA::GetFlagS ( ) const

Get the S flag.

Returns
S flag

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6Header.

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

References ns3::Icmpv6Header::GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6Address ns3::Icmpv6NA::GetIpv6Target ( ) const

Get the IPv6 target field.

Returns
IPv6 address

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

uint32_t ns3::Icmpv6NA::GetReserved ( ) const

Get the reserved field.

Returns
reserved value

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

References NS_LOG_FUNCTION.

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

Get the UID of this class.

Returns
UID

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Print information.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

Definition at line 394 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::Icmpv6NA::SetFlagO ( bool  o)

Set the O flag.

Parameters
ovalue

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::Icmpv6NA::SetFlagR ( bool  r)

Set the R flag.

Parameters
rvalue

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::Icmpv6NA::SetFlagS ( bool  s)

Set the S flag.

Parameters
svalue

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::Icmpv6NA::SetIpv6Target ( Ipv6Address  target)

Set the IPv6 target field.

Parameters
targetIPv6 address

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

References NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::Icmpv6NA::SetReserved ( uint32_t  reserved)

Set the reserved field.

Parameters
reservedthe reserved value

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

References NS_LOG_FUNCTION.

Member Data Documentation

bool ns3::Icmpv6NA::m_flagO
private

The M flag.

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

bool ns3::Icmpv6NA::m_flagR
private

The R flag.

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

bool ns3::Icmpv6NA::m_flagS
private

The O flag.

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

uint32_t ns3::Icmpv6NA::m_reserved
private

The reserved value.

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

Ipv6Address ns3::Icmpv6NA::m_target
private

The IPv6 target address.

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


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