A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::Icmpv6OptionMtu Class Reference
Internet » IPv6 classes and sub-modules » ICMPv6 protocol and associated headers.

ICMPv6 MTU option. More...

#include "icmpv6-header.h"

+ Inheritance diagram for ns3::Icmpv6OptionMtu:
+ Collaboration diagram for ns3::Icmpv6OptionMtu:

Public Member Functions

 Icmpv6OptionMtu ()
 Constructor. More...
 
 Icmpv6OptionMtu (uint32_t mtu)
 Constructor. More...
 
 ~Icmpv6OptionMtu () override
 Destructor. More...
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet. More...
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID. More...
 
uint32_t GetMtu () const
 Get the MTU. More...
 
uint16_t GetReserved () const
 Get the reserved field. More...
 
uint32_t GetSerializedSize () const override
 Get the serialized size. More...
 
void Print (std::ostream &os) const override
 Print information. More...
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet. More...
 
void SetMtu (uint32_t mtu)
 Set the MTU. More...
 
void SetReserved (uint16_t reserved)
 Set the reserved field. More...
 
- Public Member Functions inherited from ns3::Icmpv6OptionHeader
 Icmpv6OptionHeader ()
 Constructor. More...
 
 ~Icmpv6OptionHeader () override
 Destructor. More...
 
uint8_t GetLength () const
 Get the length of the option in 8 bytes unit. More...
 
uint8_t GetType () const
 Get the type of the option. More...
 
void SetLength (uint8_t len)
 Set the length of the option. More...
 
void SetType (uint8_t type)
 Set the type of the option. More...
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- 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 errors. 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::Icmpv6OptionHeader
static TypeId GetTypeId ()
 Get the UID of this class. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

uint32_t m_mtu
 The MTU value. More...
 
uint16_t m_reserved
 The reserved value. 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

Detailed Description

ICMPv6 MTU option.

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

Constructor & Destructor Documentation

◆ Icmpv6OptionMtu() [1/2]

ns3::Icmpv6OptionMtu::Icmpv6OptionMtu ( )

Constructor.

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

References ns3::Icmpv6Header::ICMPV6_OPT_MTU, NS_LOG_FUNCTION, ns3::Icmpv6OptionHeader::SetLength(), SetReserved(), and ns3::Icmpv6OptionHeader::SetType().

+ Here is the call graph for this function:

◆ Icmpv6OptionMtu() [2/2]

ns3::Icmpv6OptionMtu::Icmpv6OptionMtu ( uint32_t  mtu)

Constructor.

Parameters
mtuMTU used.

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

References ns3::Icmpv6Header::ICMPV6_OPT_MTU, NS_LOG_FUNCTION, ns3::Icmpv6OptionHeader::SetLength(), SetReserved(), and ns3::Icmpv6OptionHeader::SetType().

+ Here is the call graph for this function:

◆ ~Icmpv6OptionMtu()

ns3::Icmpv6OptionMtu::~Icmpv6OptionMtu ( )
override

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::Icmpv6OptionMtu::Deserialize ( Buffer::Iterator  start)
overridevirtual

Deserialize the packet.

Parameters
startstart offset
Returns
length of packet

Reimplemented from ns3::Icmpv6OptionHeader.

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

References GetSerializedSize(), NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU8(), ns3::Icmpv6OptionHeader::SetLength(), SetMtu(), SetReserved(), ns3::Icmpv6OptionHeader::SetType(), and two-ray-to-three-gpp-ch-calibration::start.

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Icmpv6OptionMtu::GetInstanceTypeId ( void  ) const
overridevirtual

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6OptionHeader.

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

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetMtu()

uint32_t ns3::Icmpv6OptionMtu::GetMtu ( ) const

Get the MTU.

Returns
the MTU value

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

References m_mtu, and NS_LOG_FUNCTION.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetReserved()

uint16_t ns3::Icmpv6OptionMtu::GetReserved ( ) const

Get the reserved field.

Returns
the reserved value

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

References m_reserved, and NS_LOG_FUNCTION.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::Icmpv6OptionMtu::GetSerializedSize ( ) const
overridevirtual

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6OptionHeader.

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

References NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the UID of this class.

Returns
UID

Definition at line 1648 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:

◆ Print()

void ns3::Icmpv6OptionMtu::Print ( std::ostream &  os) const
overridevirtual

Print information.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6OptionHeader.

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

References ns3::Icmpv6OptionHeader::GetLength(), ns3::Icmpv6OptionHeader::GetType(), m_mtu, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::Icmpv6OptionMtu::Serialize ( Buffer::Iterator  start) const
overridevirtual

Serialize the packet.

Parameters
startstart offset

Reimplemented from ns3::Icmpv6OptionHeader.

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

References ns3::Icmpv6OptionHeader::GetLength(), GetMtu(), GetReserved(), ns3::Icmpv6OptionHeader::GetType(), NS_LOG_FUNCTION, two-ray-to-three-gpp-ch-calibration::start, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetMtu()

void ns3::Icmpv6OptionMtu::SetMtu ( uint32_t  mtu)

Set the MTU.

Parameters
mtuthe MTU to set

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

References m_mtu, and NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ SetReserved()

void ns3::Icmpv6OptionMtu::SetReserved ( uint16_t  reserved)

Set the reserved field.

Parameters
reservedthe reserved value

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

References m_reserved, and NS_LOG_FUNCTION.

Referenced by Icmpv6OptionMtu(), and Deserialize().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_mtu

uint32_t ns3::Icmpv6OptionMtu::m_mtu
private

The MTU value.

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

Referenced by GetMtu(), Print(), and SetMtu().

◆ m_reserved

uint16_t ns3::Icmpv6OptionMtu::m_reserved
private

The reserved value.

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

Referenced by GetReserved(), and SetReserved().

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