Implements the IANA and IATA options. More...

#include "dhcp6-options.h"

Inheritance diagram for ns3::IaOptions:

Collaboration diagram for ns3::IaOptions:

Public Member Functions
	IaOptions ()
	Default constructor.

uint32_t	GetIaid () const
	Get the unique identifier for the given IANA or IATA.

uint32_t	GetT1 () const
	Get the time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

uint32_t	GetT2 () const
	Get the time interval in seconds after which the client contacts any available server to extend the address lifetime.

void	SetIaid (uint32_t iaid)
	Set the unique identifier for the given IANA or IATA.

void	SetT1 (uint32_t t1)
	Set the time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

void	SetT2 (uint32_t t2)
	Set the time interval in seconds after which the client contacts any available server to extend the address lifetime.

Public Member Functions inherited from ns3::Options
	Options ()
	Default constructor.

	Options (OptionType code, uint16_t length)
	Constructor.

OptionType	GetOptionCode () const
	Get the option code.

uint16_t	GetOptionLength () const
	Get the option length.

void	SetOptionCode (OptionType code)
	Set the option code.

void	SetOptionLength (uint16_t length)
	Set the option length.

Public Attributes
std::vector< IaAddressOption >	m_iaAddressOption
	The list of IA Address options associated with the IANA.

Private Attributes
uint32_t	m_iaid
	The unique identifier for the given IA_NA or IA_TA.

StatusCodeOption	m_statusCodeOption
	(optional) The status code of any operation involving the IANA.

uint32_t	m_t1
	The time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

uint32_t	m_t2
	The time interval in seconds after which the client contacts any available server to extend the address lifetime.

Additional Inherited Members
Public Types inherited from ns3::Options
enum class	OptionType { OPTION_INIT = 0 , OPTION_CLIENTID = 1 , OPTION_SERVERID = 2 , OPTION_IA_NA = 3 , OPTION_IA_TA = 4 , OPTION_IAADDR = 5 , OPTION_ORO = 6 , OPTION_PREFERENCE = 7 , OPTION_ELAPSED_TIME = 8 , OPTION_RELAY_MSG = 9 , OPTION_AUTH = 11 , OPTION_UNICAST = 12 , OPTION_STATUS_CODE = 13 , OPTION_RAPID_COMMIT = 14 , OPTION_USER_CLASS = 15 , OPTION_VENDOR_CLASS = 16 , OPTION_VENDOR_OPTS = 17 , OPTION_INTERFACE_ID = 18 , OPTION_RECONF_MSG = 19 , OPTION_RECONF_ACCEPT = 20 , OPTION_IA_PD = 25 , OPTION_IAPREFIX = 26 , OPTION_INFORMATION_REFRESH_TIME = 32 , OPTION_SOL_MAX_RT = 82 , OPTION_INF_MAX_RT = 83 }
	Enum to identify the option type. More...

enum class	StatusCodeValues { Success = 0 , UnspecFail = 1 , NoAddrsAvail = 2 , NoBinding = 3 , NotOnLink = 4 , UseMulticast = 5 , NoPrefixAvail = 6 }
	Enum to identify the status code of the operation. More...

Detailed Description

Implements the IANA and IATA options.

Definition at line 290 of file dhcp6-options.h.

Constructor & Destructor Documentation

◆ IaOptions()

ns3::IaOptions::IaOptions ( )

Default constructor.

Definition at line 191 of file dhcp6-options.cc.

References m_iaid, m_t1, and m_t2.

Member Function Documentation

◆ GetIaid()

uint32_t ns3::IaOptions::GetIaid ( ) const

Get the unique identifier for the given IANA or IATA.

Returns: the ID of the IANA or IATA

Definition at line 199 of file dhcp6-options.cc.

References m_iaid.

Referenced by ns3::Dhcp6Header::AddIaOption().

Here is the caller graph for this function:

◆ GetT1()

uint32_t ns3::IaOptions::GetT1 ( ) const

Get the time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

Returns: the time interval T1

Definition at line 212 of file dhcp6-options.cc.

References m_t1.

◆ GetT2()

uint32_t ns3::IaOptions::GetT2 ( ) const

Get the time interval in seconds after which the client contacts any available server to extend the address lifetime.

Returns: the time interval T2

Definition at line 225 of file dhcp6-options.cc.

References m_t2.

◆ SetIaid()

void ns3::IaOptions::SetIaid ( uint32_t iaid )

Set the unique identifier for the given IANA or IATA.

Parameters

iaid	the unique ID for the IANA or IATA.

Definition at line 205 of file dhcp6-options.cc.

References m_iaid, and NS_LOG_FUNCTION.

Referenced by ns3::Dhcp6Header::AddIaOption(), and ns3::Dhcp6Header::Deserialize().

Here is the caller graph for this function:

◆ SetT1()

void ns3::IaOptions::SetT1 ( uint32_t t1 )

Set the time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

Parameters

t1	the time interval in seconds.

Definition at line 218 of file dhcp6-options.cc.

References m_t1, and NS_LOG_FUNCTION.

Referenced by ns3::Dhcp6Header::AddIaOption(), and ns3::Dhcp6Header::Deserialize().

Here is the caller graph for this function:

◆ SetT2()

void ns3::IaOptions::SetT2 ( uint32_t t2 )

Set the time interval in seconds after which the client contacts any available server to extend the address lifetime.

Parameters

t2	time interval in seconds.

Definition at line 231 of file dhcp6-options.cc.

References m_t2, and NS_LOG_FUNCTION.

Referenced by ns3::Dhcp6Header::AddIaOption(), and ns3::Dhcp6Header::Deserialize().

Here is the caller graph for this function:

Member Data Documentation

◆ m_iaAddressOption

std::vector<IaAddressOption> ns3::IaOptions::m_iaAddressOption

The list of IA Address options associated with the IANA.

Definition at line 339 of file dhcp6-options.h.

Referenced by ns3::Dhcp6Header::Deserialize().

◆ m_iaid

uint32_t ns3::IaOptions::m_iaid

private

The unique identifier for the given IA_NA or IA_TA.

Definition at line 343 of file dhcp6-options.h.

Referenced by IaOptions(), GetIaid(), and SetIaid().

◆ m_statusCodeOption

StatusCodeOption ns3::IaOptions::m_statusCodeOption

private

(optional) The status code of any operation involving the IANA.

Definition at line 358 of file dhcp6-options.h.

◆ m_t1

uint32_t ns3::IaOptions::m_t1

private

The time interval in seconds after which the client contacts the server which provided the address to extend the lifetime.

Definition at line 349 of file dhcp6-options.h.

Referenced by IaOptions(), GetT1(), and SetT1().

◆ m_t2

uint32_t ns3::IaOptions::m_t2

private

The time interval in seconds after which the client contacts any available server to extend the address lifetime.

Definition at line 355 of file dhcp6-options.h.

Referenced by IaOptions(), GetT2(), and SetT2().

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

src/internet-apps/model/dhcp6-options.h
src/internet-apps/model/dhcp6-options.cc

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IaOptions()

Member Function Documentation

◆ GetIaid()

◆ GetT1()

◆ GetT2()

◆ SetIaid()

◆ SetT1()

◆ SetT2()

Member Data Documentation

◆ m_iaAddressOption

◆ m_iaid

◆ m_statusCodeOption

◆ m_t1

◆ m_t2