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

ICMPv6 Echo message. More...

#include <icmpv6-header.h>

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

Public Member Functions

 Icmpv6Echo ()
 Default constructor.
 Icmpv6Echo (bool request)
 Constructor.
virtual ~Icmpv6Echo ()
 Destructor.
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet.
uint16_t GetId () const
 Get the ID of the packet.
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID.
uint16_t GetSeq () const
 Get the sequence number.
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 SetId (uint16_t id)
 Set the ID of the packet.
void SetSeq (uint16_t seq)
 Set the sequence number.
- 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

uint16_t m_id
 ID of the packet (to distinguish response between many ping program).
uint16_t m_seq
 Sequence number (to distinguish response).

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

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

Constructor & Destructor Documentation

ns3::Icmpv6Echo::Icmpv6Echo ( )

Default constructor.

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

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

+ Here is the call graph for this function:

ns3::Icmpv6Echo::Icmpv6Echo ( bool  request)

Constructor.

Parameters
requestrequest or reply message

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

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

+ Here is the call graph for this function:

ns3::Icmpv6Echo::~Icmpv6Echo ( )
virtual

Destructor.

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

Member Function Documentation

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

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Reimplemented from ns3::Icmpv6Header.

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

References GetSerializedSize(), ns3::Icmpv6Header::m_checksum, m_id, m_seq, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Icmpv6Header::SetCode(), ns3::Icmpv6Header::SetType(), and visualizer.core::start().

+ Here is the call graph for this function:

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

Get the ID of the packet.

Returns
id

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

References m_id.

Referenced by ns3::Icmpv6L4Protocol::HandleEchoRequest(), and ns3::Ping6::HandleRead().

+ Here is the caller graph for this function:

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6Header.

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

References GetTypeId().

+ Here is the call graph for this function:

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

Get the sequence number.

Returns
sequence number

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

References m_seq.

Referenced by ns3::Icmpv6L4Protocol::HandleEchoRequest(), and ns3::Ping6::HandleRead().

+ Here is the caller graph for this function:

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6Header.

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

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

+ Here is the caller graph for this function:

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.

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

Print informations.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6Header.

Definition at line 890 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::Icmpv6Echo::SetId ( uint16_t  id)

Set the ID of the packet.

Parameters
idid to set

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

References m_id.

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

+ Here is the caller graph for this function:

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

Set the sequence number.

Parameters
seqsequence to set

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

References m_seq.

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

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::Icmpv6Echo::m_id
private

ID of the packet (to distinguish response between many ping program).

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

Referenced by Deserialize(), GetId(), Serialize(), and SetId().

uint16_t ns3::Icmpv6Echo::m_seq
private

Sequence number (to distinguish response).

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

Referenced by Deserialize(), GetSeq(), Serialize(), and SetSeq().


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