ns-3
ns3::Icmpv6Echo Class Reference

ICMPv6 Echo message. More...

#include <icmpv6-header.h>

Inheritance diagram for ns3::Icmpv6Echo:
Collaboration diagram for ns3::Icmpv6Echo:

List of all members.

Public Member Functions

virtual TypeId GetInstanceTypeId () const
 Get the instance type ID.
 Icmpv6Echo ()
 Default constructor.
 Icmpv6Echo (bool request)
 Constructor.
virtual ~Icmpv6Echo ()
 Destructor.
uint16_t GetId () const
 Get the ID of the packet.
void SetId (uint16_t id)
 Set the ID of the packet.
uint16_t GetSeq () const
 Get the sequence number.
void SetSeq (uint16_t seq)
 Set the sequence number.
virtual void Print (std::ostream &os) const
 Print informations.
virtual uint32_t GetSerializedSize () const
 Get the serialized size.
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet.
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet.
- Public Member Functions inherited from ns3::Icmpv6Header
 Icmpv6Header ()
 Constructor.
virtual ~Icmpv6Header ()
 Destructor.
uint8_t GetType () const
 Get the type field.
void SetType (uint8_t type)
 Set the type.
uint8_t GetCode () const
 Get the code field.
void SetCode (uint8_t code)
 Set the code field.
uint16_t GetChecksum () const
 Get the checksum.
void SetChecksum (uint16_t checksum)
 Set the checksum.
void CalculatePseudoHeaderChecksum (Ipv6Address src, Ipv6Address dst, uint16_t length, uint8_t protocol)
 Calculate pseudo header checksum for IPv6.

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from ns3::Icmpv6Header
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.
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.
enum  ErrorDestinationUnreachable_e {
  ICMPV6_NO_ROUTE = 0, ICMPV6_ADM_PROHIBITED, ICMPV6_NOT_NEIGHBOUR, ICMPV6_ADDR_UNREACHABLE,
  ICMPV6_PORT_UNREACHABLE
}
 ICMPv6 error code : Destination Unreachable.
enum  ErrorTimeExceeded_e { ICMPV6_HOPLIMIT = 0, ICMPV6_FRAGTIME }
 ICMPv6 error code : Time Exceeded.
enum  ErrorParameterError_e { ICMPV6_MALFORMED_HEADER = 0, ICMPV6_UNKNOWN_NEXT_HEADER, ICMPV6_UNKNOWN_OPTION }
 ICMPv6 error code : Parameter Error.
- Protected Attributes inherited from ns3::Icmpv6Header
bool m_calcChecksum
 Checksum enable or not.
uint16_t m_checksum
 The checksum.

Detailed Description

ICMPv6 Echo message.


Constructor & Destructor Documentation

ns3::Icmpv6Echo::Icmpv6Echo ( bool  request)

Constructor.

Parameters:
requestrequest or reply message

References ns3::Icmpv6Header::m_checksum, ns3::Icmpv6Header::SetCode(), SetId(), SetSeq(), and ns3::Icmpv6Header::SetType().


Member Function Documentation

uint32_t ns3::Icmpv6Echo::Deserialize ( Buffer::Iterator  start)
virtual
uint16_t ns3::Icmpv6Echo::GetId ( void  ) const

Get the ID of the packet.

Returns:
id
TypeId ns3::Icmpv6Echo::GetInstanceTypeId ( void  ) const
virtual

Get the instance type ID.

Returns:
instance type ID

Reimplemented from ns3::Icmpv6Header.

References GetTypeId().

uint16_t ns3::Icmpv6Echo::GetSeq ( void  ) const

Get the sequence number.

Returns:
sequence number
uint32_t ns3::Icmpv6Echo::GetSerializedSize ( void  ) const
virtual

Get the serialized size.

Returns:
serialized size

Reimplemented from ns3::Icmpv6Header.

Referenced by Deserialize(), ns3::Icmpv6L4Protocol::SendEchoReply(), and ns3::Ipv6RawSocketImpl::SendTo().

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

Get the UID of this class.

This method returns the TypeId associated to ns3::Icmpv6Echo.

Returns:
UID

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Icmpv6Header.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

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

Print informations.

Parameters:
osoutput stream

Reimplemented from ns3::Icmpv6Header.

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

void ns3::Icmpv6Echo::SetId ( uint16_t  id)

Set the ID of the packet.

Parameters:
idid to set

Referenced by ns3::Icmpv6L4Protocol::ForgeEchoRequest(), Icmpv6Echo(), and ns3::Icmpv6L4Protocol::SendEchoReply().

void ns3::Icmpv6Echo::SetSeq ( uint16_t  seq)

Set the sequence number.

Parameters:
seqsequence to set

Referenced by ns3::Icmpv6L4Protocol::ForgeEchoRequest(), Icmpv6Echo(), and ns3::Icmpv6L4Protocol::SendEchoReply().


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