/usr/include/ns3.27/ns3/dhcp-helper.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 UPB
* Copyright (c) 2017 NITK Surathkal
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Radu Lupu <rlupu@elcom.pub.ro>
* Ankit Deepak <adadeepak8@gmail.com>
* Deepti Rajagopal <deeptir96@gmail.com>
*
*/
#ifndef DHCP_HELPER_H
#define DHCP_HELPER_H
#include <stdint.h>
#include "ns3/application-container.h"
#include "ns3/net-device-container.h"
#include "ns3/object-factory.h"
#include "ns3/ipv4-address.h"
#include "ns3/ipv4-interface-container.h"
namespace ns3 {
/**
* \ingroup dhcp
*
* \class DhcpHelper
* \brief The helper class used to configure and install DHCP applications on nodes
*/
class DhcpHelper
{
public:
DhcpHelper ();
/**
* \brief Set DHCP client attributes
* \param name Name of the attribute
* \param value Value to be set
*/
void SetClientAttribute (std::string name, const AttributeValue &value);
/**
* \brief Set DHCP server attributes
* \param name Name of the attribute
* \param value Value to be set
*/
void SetServerAttribute (std::string name, const AttributeValue &value);
/**
* \brief Install DHCP client of a nodes / NetDevice
* \param netDevice The NetDevice that the DHCP client will use
* \return The application container with DHCP client installed
*/
ApplicationContainer InstallDhcpClient (Ptr<NetDevice> netDevice) const;
/**
* \brief Install DHCP client of a set of nodes / NetDevices
* \param netDevices The NetDevices that the DHCP client will use
* \return The application container with DHCP client installed
*/
ApplicationContainer InstallDhcpClient (NetDeviceContainer netDevices) const;
/**
* \brief 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.
*
* \param netDevice The NetDevice on which DHCP server application has to be installed
* \param serverAddr The Ipv4Address of the server
* \param poolAddr The Ipv4Address (network part) of the allocated pool
* \param poolMask The mask of the allocated pool
* \param minAddr The lower bound of the Ipv4Address pool
* \param maxAddr The upper bound of the Ipv4Address pool
* \param gateway The Ipv4Address of default gateway (optional)
* \return The application container with DHCP server installed
*/
ApplicationContainer InstallDhcpServer (Ptr<NetDevice> netDevice, Ipv4Address serverAddr,
Ipv4Address poolAddr, Ipv4Mask poolMask,
Ipv4Address minAddr, Ipv4Address maxAddr,
Ipv4Address gateway = Ipv4Address ());
/**
* \brief Assign a fixed IP addresses to a net device.
* \param netDevice The NetDevice on which the address has to be installed
* \param addr The Ipv4Address
* \param mask The network mask
* \return the Ipv4 interface container
*/
Ipv4InterfaceContainer InstallFixedAddress (Ptr<NetDevice> netDevice, Ipv4Address addr, Ipv4Mask mask);
private:
/**
* \brief Function to install DHCP client on a node
* \param netDevice The NetDevice on which DHCP client application has to be installed
* \return The pointer to the installed DHCP client
*/
Ptr<Application> InstallDhcpClientPriv (Ptr<NetDevice> netDevice) const;
ObjectFactory m_clientFactory; //!< DHCP client factory
ObjectFactory m_serverFactory; //!< DHCP server factory
std::list<Ipv4Address> m_fixedAddresses; //!< list of fixed addresses already allocated.
std::list< std::pair <Ipv4Address, Ipv4Address> > m_addressPools; //!< list of address pools.
};
} // namespace ns3
#endif /* DHCP_HELPER_H */
|