The helper class used to configure and install DHCP applications on nodes. More...

#include "dhcp-helper.h"

Collaboration diagram for ns3::DhcpHelper:

Public Member Functions
	DhcpHelper ()

ApplicationContainer	InstallDhcpClient (NetDeviceContainer netDevices) const
	Install DHCP client of a set of nodes / NetDevices. More...

ApplicationContainer	InstallDhcpClient (Ptr< NetDevice > netDevice) const
	Install DHCP client of a nodes / NetDevice. More...

ApplicationContainer	InstallDhcpServer (Ptr< NetDevice > netDevice, Ipv4Address serverAddr, Ipv4Address poolAddr, Ipv4Mask poolMask, Ipv4Address minAddr, Ipv4Address maxAddr, Ipv4Address gateway=Ipv4Address())
	Install DHCP server of a node / NetDevice. More...

Ipv4InterfaceContainer	InstallFixedAddress (Ptr< NetDevice > netDevice, Ipv4Address addr, Ipv4Mask mask)
	Assign a fixed IP addresses to a net device. More...

void	SetClientAttribute (std::string name, const AttributeValue &value)
	Set DHCP client attributes. More...

void	SetServerAttribute (std::string name, const AttributeValue &value)
	Set DHCP server attributes. More...

Private Member Functions
Ptr< Application >	InstallDhcpClientPriv (Ptr< NetDevice > netDevice) const
	Function to install DHCP client on a node. More...

Private Attributes
std::list< std::pair< Ipv4Address, Ipv4Address > >	m_addressPools
	list of address pools. More...

ObjectFactory	m_clientFactory
	DHCP client factory. More...

std::list< Ipv4Address >	m_fixedAddresses
	list of fixed addresses already allocated. More...

ObjectFactory	m_serverFactory
	DHCP server factory. More...

Detailed Description

The helper class used to configure and install DHCP applications on nodes.

Definition at line 43 of file dhcp-helper.h.

Constructor & Destructor Documentation

◆ DhcpHelper()

ns3::DhcpHelper::DhcpHelper ( )

Definition at line 41 of file dhcp-helper.cc.

References ns3::DhcpClient::GetTypeId(), ns3::DhcpServer::GetTypeId(), m_clientFactory, m_serverFactory, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

Member Function Documentation

◆ InstallDhcpClient() [1/2]

ApplicationContainer ns3::DhcpHelper::InstallDhcpClient ( NetDeviceContainer netDevices ) const

Install DHCP client of a set of nodes / NetDevices.

Parameters

netDevices The NetDevices that the DHCP client will use

Returns: The application container with DHCP client installed

Definition at line 66 of file dhcp-helper.cc.

References ns3::ApplicationContainer::Add(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and InstallDhcpClientPriv().

Here is the call graph for this function:

◆ InstallDhcpClient() [2/2]

ApplicationContainer ns3::DhcpHelper::InstallDhcpClient ( Ptr< NetDevice > netDevice ) const

Install DHCP client of a nodes / NetDevice.

Parameters

netDevice The NetDevice that the DHCP client will use

Returns: The application container with DHCP client installed

Definition at line 61 of file dhcp-helper.cc.

References InstallDhcpClientPriv().

Referenced by DhcpTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallDhcpClientPriv()

Ptr< Application > ns3::DhcpHelper::InstallDhcpClientPriv ( Ptr< NetDevice > netDevice ) const

private

Function to install DHCP client on a node.

Parameters

netDevice The NetDevice on which DHCP client application has to be installed

Returns: The pointer to the installed DHCP client

Definition at line 76 of file dhcp-helper.cc.

References ns3::Node::AddApplication(), ns3::ObjectFactory::Create(), ns3::TrafficControlHelper::Default(), ns3::NetDevice::GetNode(), ns3::Object::GetObject(), ns3::TrafficControlHelper::Install(), m_clientFactory, NS_ASSERT_MSG, and NS_LOG_LOGIC.

Referenced by InstallDhcpClient().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallDhcpServer()

ApplicationContainer ns3::DhcpHelper::InstallDhcpServer	(	Ptr< NetDevice >	netDevice,
		Ipv4Address	serverAddr,
		Ipv4Address	poolAddr,
		Ipv4Mask	poolMask,
		Ipv4Address	minAddr,
		Ipv4Address	maxAddr,
		Ipv4Address	gateway = `Ipv4Address ()`
	)

Install DHCP server of a node / NetDevice.

Note: the server address must be coherent with the pool address, because DHCP relays are not yet supported.

Parameters

netDevice	The NetDevice on which DHCP server application has to be installed
serverAddr	The Ipv4Address of the server
poolAddr	The Ipv4Address (network part) of the allocated pool
poolMask	The mask of the allocated pool
minAddr	The lower bound of the Ipv4Address pool
maxAddr	The upper bound of the Ipv4Address pool
gateway	The Ipv4Address of default gateway (optional)