A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::Icmpv6NS Class Reference

ICMPv6 Neighbor Solicitation header. More...

#include <icmpv6-header.h>

+ Inheritance diagram for ns3::Icmpv6NS:
+ Collaboration diagram for ns3::Icmpv6NS:

Public Member Functions

 Icmpv6NS (Ipv6Address target)
 Constructor.
 Icmpv6NS ()
 Constructor.
virtual ~Icmpv6NS ()
 Destructor.
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet.
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID.
Ipv6Address GetIpv6Target () const
 Get the IPv6 target field.
uint32_t GetReserved () const
 Get the reserved field.
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 SetIpv6Target (Ipv6Address target)
 Set the IPv6 target field.
void SetReserved (uint32_t reserved)
 Set the reserved field.
- 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

uint32_t m_reserved
 The reserved value.
Ipv6Address m_target
 The IPv6 target address.

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 Neighbor Solicitation header.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::Icmpv6NS::Icmpv6NS ( Ipv6Address  target)

Constructor.

Parameters
targettarget IPv6 address

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

References ns3::Icmpv6Header::ICMPV6_ND_NEIGHBOR_SOLICITATION, ns3::Icmpv6Header::m_checksum, NS_LOG_FUNCTION, ns3::Icmpv6Header::SetCode(), SetIpv6Target(), SetReserved(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

ns3::Icmpv6NS::Icmpv6NS ( )

Constructor.

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

References ns3::Icmpv6Header::ICMPV6_ND_NEIGHBOR_SOLICITATION, ns3::Icmpv6Header::m_checksum, NS_LOG_FUNCTION, ns3::Icmpv6Header::SetCode(), SetReserved(), and ns3::Icmpv6Header::SetType().

+ Here is the call graph for this function:

ns3::Icmpv6NS::~Icmpv6NS ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::Icmpv6NS::Deserialize ( Buffer::Iterator  start)
virtual

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Reimplemented from ns3::Icmpv6Header.

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

References GetSerializedSize(), ns3::Icmpv6Header::m_checksum, m_reserved, m_target, NS_LOG_FUNCTION, ns3::Buffer::Iterator::Read(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Ipv6Address::Set(), ns3::Icmpv6Header::SetCode(), ns3::Icmpv6Header::SetType(), and visualizer.core::start().

+ Here is the call graph for this function:

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6Header.

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

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6Address ns3::Icmpv6NS::GetIpv6Target ( ) const

Get the IPv6 target field.

Returns
IPv6 address

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

References m_target, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

uint32_t ns3::Icmpv6NS::GetReserved ( ) const

Get the reserved field.

Returns
reserved value

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

References m_reserved, and NS_LOG_FUNCTION.

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

References NS_LOG_FUNCTION.

Referenced by Deserialize(), and ns3::Icmpv6L4Protocol::ForgeNS().

+ Here is the caller graph for this function:

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

Get the UID of this class.

Returns
UID

Reimplemented from ns3::Icmpv6Header.

Definition at line 186 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::Icmpv6NS::Print ( std::ostream &  os) const
virtual

Print informations.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

Definition at line 245 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::Icmpv6NS::Serialize ( Buffer::Iterator  start) const
virtual

Serialize the packet.

Parameters
startstart offset

Reimplemented from ns3::Icmpv6Header.

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

References ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Icmpv6Header::GetCode(), ns3::Buffer::Iterator::GetSize(), ns3::Icmpv6Header::GetType(), ns3::Icmpv6Header::m_calcChecksum, ns3::Icmpv6Header::m_checksum, m_reserved, m_target, ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, ns3::Ipv6Address::Serialize(), visualizer.core::start(), ns3::Buffer::Iterator::Write(), ns3::Buffer::Iterator::WriteHtonU32(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

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

Set the IPv6 target field.

Parameters
targetIPv6 address

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

References m_target, and NS_LOG_FUNCTION.

Referenced by Icmpv6NS().

+ Here is the caller graph for this function:

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

Set the reserved field.

Parameters
reservedthe reserved value

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

References m_reserved, and NS_LOG_FUNCTION.

Referenced by Icmpv6NS().

+ Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::Icmpv6NS::m_reserved
private

The reserved value.

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

Referenced by Deserialize(), GetReserved(), Serialize(), and SetReserved().

Ipv6Address ns3::Icmpv6NS::m_target
private

The IPv6 target address.

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

Referenced by Deserialize(), GetIpv6Target(), Serialize(), and SetIpv6Target().

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