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

ICMPv6 Option Prefix Information. More...

#include <icmpv6-header.h>

+ Inheritance diagram for ns3::Icmpv6OptionPrefixInformation:
+ Collaboration diagram for ns3::Icmpv6OptionPrefixInformation:

Public Member Functions

 Icmpv6OptionPrefixInformation ()
 Constructor.
 Icmpv6OptionPrefixInformation (Ipv6Address network, uint8_t prefixlen)
 Constructor.
virtual ~Icmpv6OptionPrefixInformation ()
 Destructor.
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet.
uint8_t GetFlags () const
 Get the flags.
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID.
uint32_t GetPreferredTime () const
 Get the preferred time of the information.
Ipv6Address GetPrefix () const
 Get the IPv6 prefix.
uint8_t GetPrefixLength () const
 Get the prefix length.
uint32_t GetReserved () const
 Get the reserved field.
virtual uint32_t GetSerializedSize () const
 Get the serialized size.
uint32_t GetValidTime () const
 Get the valid time of the information.
virtual void Print (std::ostream &os) const
 Print informations.
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet.
void SetFlags (uint8_t flags)
 Set the flags.
void SetPreferredTime (uint32_t preferredTime)
 Set the preferred time of the information.
void SetPrefix (Ipv6Address prefix)
 Set the IPv6 prefix.
void SetPrefixLength (uint8_t prefixLength)
 Set the prefix length.
void SetReserved (uint32_t reserved)
 Set the reserved field (normally it will be 0x00000000).
void SetValidTime (uint32_t validTime)
 Set the valid time of the information.
- Public Member Functions inherited from ns3::Icmpv6OptionHeader
 Icmpv6OptionHeader ()
 Constructor.
virtual ~Icmpv6OptionHeader ()
 Destructor.
uint8_t GetLength () const
 Get the length of the option in 8 bytes unit.
uint8_t GetType () const
 Get the type of the option.
void SetLength (uint8_t len)
 Set the length of the option.
void SetType (uint8_t type)
 Set the type of the option.
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

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

Private Attributes

uint8_t m_flags
 The flags.
uint32_t m_preferredTime
 The preferred time.
Ipv6Address m_prefix
 The prefix value.
uint8_t m_prefixLength
 The length of the prefix.
uint32_t m_reserved
 The reserved field.
uint32_t m_validTime
 The valid time.

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

ICMPv6 Option Prefix Information.

This type is not accessible from the Config system.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::Icmpv6OptionPrefixInformation::Icmpv6OptionPrefixInformation ( )
ns3::Icmpv6OptionPrefixInformation::Icmpv6OptionPrefixInformation ( Ipv6Address  network,
uint8_t  prefixlen 
)

Constructor.

Parameters
networkprefix
prefixlenprefix length

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

References ns3::Icmpv6Header::ICMPV6_OPT_PREFIX, SetFlags(), ns3::Icmpv6OptionHeader::SetLength(), SetPreferredTime(), SetPrefix(), SetPrefixLength(), SetReserved(), ns3::Icmpv6OptionHeader::SetType(), and SetValidTime().

+ Here is the call graph for this function:

ns3::Icmpv6OptionPrefixInformation::~Icmpv6OptionPrefixInformation ( )
virtual

Destructor.

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

Member Function Documentation

uint32_t ns3::Icmpv6OptionPrefixInformation::Deserialize ( Buffer::Iterator  start)
virtual
uint8_t ns3::Icmpv6OptionPrefixInformation::GetFlags ( ) const

Get the flags.

Returns
the flags.

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

References m_flags.

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

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::Icmpv6OptionHeader.

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

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::Icmpv6OptionPrefixInformation::GetPreferredTime ( ) const

Get the preferred time of the information.

Returns
preferred time

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

References m_preferredTime.

Ipv6Address ns3::Icmpv6OptionPrefixInformation::GetPrefix ( ) const

Get the IPv6 prefix.

Returns
IPv6 prefix

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

References m_prefix.

uint8_t ns3::Icmpv6OptionPrefixInformation::GetPrefixLength ( ) const

Get the prefix length.

Returns
prefix length

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

References m_prefixLength.

uint32_t ns3::Icmpv6OptionPrefixInformation::GetReserved ( ) const

Get the reserved field.

Returns
the reserved field (should be 0x00000000)

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

References m_preferredTime.

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

Get the serialized size.

Returns
serialized size

Reimplemented from ns3::Icmpv6OptionHeader.

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

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

Get the UID of this class.

Returns
UID

Reimplemented from ns3::Icmpv6OptionHeader.

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

uint32_t ns3::Icmpv6OptionPrefixInformation::GetValidTime ( ) const

Get the valid time of the information.

Returns
valid time

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

References m_validTime.

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

Print informations.

Parameters
osoutput stream

Reimplemented from ns3::Icmpv6OptionHeader.

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

References ns3::Icmpv6OptionHeader::GetLength(), ns3::Icmpv6OptionHeader::GetType(), and m_prefix.

+ Here is the call graph for this function:

void ns3::Icmpv6OptionPrefixInformation::Serialize ( Buffer::Iterator  start) const
virtual
void ns3::Icmpv6OptionPrefixInformation::SetFlags ( uint8_t  flags)

Set the flags.

Parameters
flagsthe flags to set

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

References m_flags.

Referenced by Deserialize(), Icmpv6OptionPrefixInformation(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

void ns3::Icmpv6OptionPrefixInformation::SetPreferredTime ( uint32_t  preferredTime)

Set the preferred time of the information.

Parameters
preferredTimepreferred time

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

References m_preferredTime.

Referenced by Deserialize(), Icmpv6OptionPrefixInformation(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

void ns3::Icmpv6OptionPrefixInformation::SetPrefix ( Ipv6Address  prefix)

Set the IPv6 prefix.

Parameters
prefixthe IPv6 prefix

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

References m_prefix.

Referenced by Deserialize(), Icmpv6OptionPrefixInformation(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

void ns3::Icmpv6OptionPrefixInformation::SetPrefixLength ( uint8_t  prefixLength)

Set the prefix length.

Parameters
prefixLengththe prefix length

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

References m_prefixLength, and NS_ASSERT.

Referenced by Deserialize(), Icmpv6OptionPrefixInformation(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

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

Set the reserved field (normally it will be 0x00000000).

Parameters
reservedreserved value

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

References m_reserved.

Referenced by Deserialize(), and Icmpv6OptionPrefixInformation().

+ Here is the caller graph for this function:

void ns3::Icmpv6OptionPrefixInformation::SetValidTime ( uint32_t  validTime)

Set the valid time of the information.

Parameters
validTimevalid time

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

References m_validTime.

Referenced by Deserialize(), Icmpv6OptionPrefixInformation(), and ns3::Radvd::Send().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::Icmpv6OptionPrefixInformation::m_flags
private

The flags.

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

Referenced by GetFlags(), Serialize(), and SetFlags().

uint32_t ns3::Icmpv6OptionPrefixInformation::m_preferredTime
private

The preferred time.

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

Referenced by GetPreferredTime(), GetReserved(), Serialize(), and SetPreferredTime().

Ipv6Address ns3::Icmpv6OptionPrefixInformation::m_prefix
private

The prefix value.

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

Referenced by GetPrefix(), Print(), Serialize(), and SetPrefix().

uint8_t ns3::Icmpv6OptionPrefixInformation::m_prefixLength
private

The length of the prefix.

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

Referenced by GetPrefixLength(), Serialize(), and SetPrefixLength().

uint32_t ns3::Icmpv6OptionPrefixInformation::m_reserved
private

The reserved field.

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

Referenced by Serialize(), and SetReserved().

uint32_t ns3::Icmpv6OptionPrefixInformation::m_validTime
private

The valid time.

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

Referenced by GetValidTime(), Serialize(), and SetValidTime().


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