ns3::LeaseInfo Class Reference

Includes information about available subnets and corresponding leases. More...

#include "dhcp6-server.h"

Collaboration diagram for ns3::LeaseInfo:

Public Member Functions
	LeaseInfo (Ipv6Address addressPool, Ipv6Prefix prefix, Ipv6Address minAddress, Ipv6Address maxAddress)
	Constructor.

Private Types
typedef std::unordered_map< Ipv6Address, Duid, Ipv6AddressHash >	DeclinedAddresses
	Declined Addresses Ipv6Address + Client DUID.
typedef std::multimap< Time, std::pair< Duid, Ipv6Address > >	ExpiredAddresses
	Expired Addresses (Section 6.2 of RFC 8415) Expired time / Ipv6Address.
typedef std::unordered_multimap< Duid, std::pair< Ipv6Address, Time >, Duid::DuidHash >	LeasedAddresses
	Leased Addresses Client DUID + Ipv6Address / Lease time.

Private Member Functions
Ipv6Address	GetAddressPool () const
	Get the address pool.
Ipv6Address	GetMaxAddress () const
	Get the maximum address in the pool.
Ipv6Address	GetMinAddress () const
	Get the minimum address in the pool.
uint32_t	GetNumAddresses () const
	Get the number of addresses leased.
Ipv6Prefix	GetPrefix () const
	Get the prefix of the address pool.

Private Attributes
Ipv6Address	m_addressPool
	Address pool.
DeclinedAddresses	m_declinedAddresses
	Declined addresses.
ExpiredAddresses	m_expiredAddresses
	Expired addresses.
LeasedAddresses	m_leasedAddresses
	Leased addresses.
Ipv6Address	m_maxAddress
	Maximum address in the pool.
Ipv6Address	m_maxOfferedAddress
	Maximum address offered so far.
Ipv6Address	m_minAddress
	Minimum address in the pool.
uint32_t	m_numAddresses
	Number of addresses leased.
Ipv6Prefix	m_prefix
	Prefix of the address pool.

Friends
class	Dhcp6Server

Detailed Description

Includes information about available subnets and corresponding leases.

Definition at line 37 of file dhcp6-server.h.

Member Typedef Documentation

DeclinedAddresses

typedef std::unordered_map<Ipv6Address, Duid, Ipv6AddressHash> ns3::LeaseInfo::DeclinedAddresses

private

Declined Addresses Ipv6Address + Client DUID.

Definition at line 102 of file dhcp6-server.h.

ExpiredAddresses

typedef std::multimap<Time, std::pair<Duid, Ipv6Address> > ns3::LeaseInfo::ExpiredAddresses

private

Expired Addresses (Section 6.2 of RFC 8415) Expired time / Ipv6Address.

Definition at line 89 of file dhcp6-server.h.

LeasedAddresses

typedef std::unordered_multimap<Duid, std::pair<Ipv6Address, Time>, Duid::DuidHash> ns3::LeaseInfo::LeasedAddresses

private

Leased Addresses Client DUID + Ipv6Address / Lease time.

Definition at line 96 of file dhcp6-server.h.

Constructor & Destructor Documentation

LeaseInfo()

ns3::LeaseInfo::LeaseInfo	(	Ipv6Address	addressPool,
		Ipv6Prefix	prefix,
		Ipv6Address	minAddress,
		Ipv6Address	maxAddress )

Constructor.

Parameters

addressPool	Address pool
prefix	Prefix of the address pool
minAddress	Minimum address in the pool
maxAddress	Maximum address in the pool

Definition at line 817 of file dhcp6-server.cc.

References m_addressPool, m_maxAddress, m_minAddress, m_numAddresses, and m_prefix.

Member Function Documentation

GetAddressPool()

Ipv6Address ns3::LeaseInfo::GetAddressPool ( ) const

private

Get the address pool.

Returns

The address pool

Definition at line 830 of file dhcp6-server.cc.

References m_addressPool.

GetMaxAddress()

Ipv6Address ns3::LeaseInfo::GetMaxAddress ( ) const

private

Get the maximum address in the pool.

Returns

The maximum address in the pool

Definition at line 848 of file dhcp6-server.cc.

References m_maxAddress.

GetMinAddress()

Ipv6Address ns3::LeaseInfo::GetMinAddress ( ) const

private

Get the minimum address in the pool.

Returns

The minimum address in the pool

Definition at line 842 of file dhcp6-server.cc.

References m_minAddress.

GetNumAddresses()

uint32_t ns3::LeaseInfo::GetNumAddresses ( ) const

private

Get the number of addresses leased.

Returns

The number of addresses leased

Definition at line 854 of file dhcp6-server.cc.

References m_numAddresses.

GetPrefix()

Ipv6Prefix ns3::LeaseInfo::GetPrefix ( ) const

private

Get the prefix of the address pool.

Returns

The prefix of the address pool

Definition at line 836 of file dhcp6-server.cc.

References m_prefix.

Friends And Related Symbol Documentation

Dhcp6Server

friend class Dhcp6Server

friend

Definition at line 52 of file dhcp6-server.h.

References Dhcp6Server.

Referenced by Dhcp6Server.

Member Data Documentation

m_addressPool

Ipv6Address ns3::LeaseInfo::m_addressPool

private

Address pool.

Definition at line 109 of file dhcp6-server.h.

Referenced by LeaseInfo(), and GetAddressPool().

m_declinedAddresses

DeclinedAddresses ns3::LeaseInfo::m_declinedAddresses

private

Declined addresses.

Definition at line 106 of file dhcp6-server.h.

m_expiredAddresses

ExpiredAddresses ns3::LeaseInfo::m_expiredAddresses

private

Expired addresses.

Definition at line 105 of file dhcp6-server.h.

m_leasedAddresses

LeasedAddresses ns3::LeaseInfo::m_leasedAddresses

private

Leased addresses.

Definition at line 104 of file dhcp6-server.h.

m_maxAddress

Ipv6Address ns3::LeaseInfo::m_maxAddress

private

Maximum address in the pool.

Definition at line 112 of file dhcp6-server.h.

Referenced by LeaseInfo(), and GetMaxAddress().

m_maxOfferedAddress

Ipv6Address ns3::LeaseInfo::m_maxOfferedAddress

private

Maximum address offered so far.

Definition at line 107 of file dhcp6-server.h.

m_minAddress

Ipv6Address ns3::LeaseInfo::m_minAddress

private

Minimum address in the pool.

Definition at line 111 of file dhcp6-server.h.

Referenced by LeaseInfo(), and GetMinAddress().

m_numAddresses

uint32_t ns3::LeaseInfo::m_numAddresses

private

Number of addresses leased.

Definition at line 113 of file dhcp6-server.h.

Referenced by LeaseInfo(), and GetNumAddresses().

m_prefix

Ipv6Prefix ns3::LeaseInfo::m_prefix

private

Prefix of the address pool.

Definition at line 110 of file dhcp6-server.h.

Referenced by LeaseInfo(), and GetPrefix().

---

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

• src/internet-apps/model/dhcp6-server.h
• src/internet-apps/model/dhcp6-server.cc