A Discrete-Event Network Simulator
API

ICMPv6 header. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6Header:
+ Collaboration diagram for ns3::Icmpv6Header:

Public Types

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

Public Member Functions

 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...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet. More...
 
uint16_t GetChecksum () const
 Get the checksum. More...
 
uint8_t GetCode () const
 Get the code field. More...
 
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID. More...
 
virtual uint32_t GetSerializedSize () const
 Get the serialized size. More...
 
uint8_t GetType () const
 Get the type field. More...
 
virtual void Print (std::ostream &os) const
 Print information. More...
 
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet. 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::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...
 

Protected Attributes

bool m_calcChecksum
 Checksum enable or not. More...
 
uint16_t m_checksum
 The checksum. More...
 

Private Attributes

uint8_t m_code
 The code. More...
 
uint8_t m_type
 The type. More...
 

Additional Inherited Members

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

Detailed Description

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

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

Member Enumeration Documentation

ICMPv6 error code : Destination Unreachable.

Enumerator
ICMPV6_NO_ROUTE 
ICMPV6_ADM_PROHIBITED 
ICMPV6_NOT_NEIGHBOUR 
ICMPV6_ADDR_UNREACHABLE 
ICMPV6_PORT_UNREACHABLE 

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

ICMPv6 error code : Parameter Error.

Enumerator
ICMPV6_MALFORMED_HEADER 
ICMPV6_UNKNOWN_NEXT_HEADER 
ICMPV6_UNKNOWN_OPTION 

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

ICMPv6 error code : Time Exceeded.

Enumerator
ICMPV6_HOPLIMIT 
ICMPV6_FRAGTIME 

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

ICMPv6 Option type code.

Enumerator
ICMPV6_OPT_LINK_LAYER_SOURCE 
ICMPV6_OPT_LINK_LAYER_TARGET 
ICMPV6_OPT_PREFIX 
ICMPV6_OPT_REDIRECTED 
ICMPV6_OPT_MTU 

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

ICMPv6 type code.

Enumerator
ICMPV6_ERROR_DESTINATION_UNREACHABLE 
ICMPV6_ERROR_PACKET_TOO_BIG 
ICMPV6_ERROR_TIME_EXCEEDED 
ICMPV6_ERROR_PARAMETER_ERROR 
ICMPV6_ECHO_REQUEST 
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 

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

Constructor & Destructor Documentation

ns3::Icmpv6Header::Icmpv6Header ( )

Constructor.

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

References NS_LOG_FUNCTION.

ns3::Icmpv6Header::~Icmpv6Header ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::Icmpv6Header::CalculatePseudoHeaderChecksum ( Ipv6Address  src,
Ipv6Address  dst,
uint16_t  length,
uint8_t  protocol 
)
uint32_t ns3::Icmpv6Header::Deserialize ( Buffer::Iterator  start)
virtual
TypeId ns3::Icmpv6Header::GetInstanceTypeId ( void  ) const
virtual

Get the instance type ID.

Returns
instance type ID

Implements ns3::ObjectBase.

Reimplemented in ns3::Icmpv6ParameterError, ns3::Icmpv6TimeExceeded, ns3::Icmpv6TooBig, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6Echo, ns3::Icmpv6Redirection, ns3::Icmpv6RS, ns3::Icmpv6RA, ns3::Icmpv6NA, and ns3::Icmpv6NS.

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

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

uint32_t ns3::Icmpv6Header::GetSerializedSize ( void  ) const
virtual
TypeId ns3::Icmpv6Header::GetTypeId ( void  )
static

Get the UID of this class.

Returns
UID

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId(), ns3::Icmpv6NS::GetInstanceTypeId(), ns3::Icmpv6NA::GetInstanceTypeId(), ns3::Icmpv6RA::GetInstanceTypeId(), ns3::Icmpv6RS::GetInstanceTypeId(), and ns3::Icmpv6Redirection::GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::Icmpv6Header::Print ( std::ostream &  os) const
virtual
void ns3::Icmpv6Header::SetChecksum ( uint16_t  checksum)

Set the checksum.

Parameters
checksumto set

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

References m_checksum, and NS_LOG_FUNCTION.

Member Data Documentation

bool ns3::Icmpv6Header::m_calcChecksum
protected
uint8_t ns3::Icmpv6Header::m_code
private

The code.

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

Referenced by Deserialize(), GetCode(), Print(), Serialize(), and SetCode().


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