A Discrete-Event Network Simulator
API
ns3::DhcpServer Class Reference

Implements the functionality of a DHCP server. More...

#include "dhcp-server.h"

+ Inheritance diagram for ns3::DhcpServer:
+ Collaboration diagram for ns3::DhcpServer:

Public Member Functions

 DhcpServer ()
 
virtual ~DhcpServer ()
 
void AddStaticDhcpEntry (Address chaddr, Ipv4Address addr)
 Add a static entry to the pool. More...
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Types

typedef std::list< Ipv4AddressAvailableAddress
 Available address container - IP addr. More...
 
typedef std::list< AddressExpiredAddress
 Expired address container - chaddr. More...
 
typedef std::list< Address >::const_iterator ExpiredAddressCIter
 Expired address const iterator - chaddr. More...
 
typedef std::list< Address >::iterator ExpiredAddressIter
 Expired address iterator - chaddr. More...
 
typedef std::map< Address, std::pair< Ipv4Address, uint32_t > > LeasedAddress
 Leased address container - chaddr + IP addr / lease time. More...
 
typedef std::map< Address, std::pair< Ipv4Address, uint32_t > >::const_iterator LeasedAddressCIter
 Leased address const iterator - chaddr + IP addr / lease time. More...
 
typedef std::map< Address, std::pair< Ipv4Address, uint32_t > >::iterator LeasedAddressIter
 Leased address iterator - chaddr + IP addr / lease time. More...
 

Private Member Functions

void NetHandler (Ptr< Socket > socket)
 Handles incoming packets from the network. More...
 
void SendAck (Ptr< NetDevice > iDev, DhcpHeader header, InetSocketAddress from)
 Sends DHCP ACK (or NACK) after receiving Request. More...
 
void SendOffer (Ptr< NetDevice > iDev, DhcpHeader header, InetSocketAddress from)
 Sends DHCP offer after receiving DHCP Discover. More...
 
virtual void StartApplication (void)
 Starts the DHCP Server application. More...
 
virtual void StopApplication (void)
 Stops the DHCP client application. More...
 
void TimerHandler (void)
 Modifies the remaining lease time of addresses. More...
 

Private Attributes

AvailableAddress m_availableAddresses
 Available addresses to be used (IP addresses) More...
 
ExpiredAddress m_expiredAddresses
 Expired addresses to be reused (chaddr of the clients) More...
 
EventId m_expiredEvent
 The Event to trigger TimerHandler. More...
 
Ipv4Address m_gateway
 The gateway address. More...
 
Time m_lease
 The granted lease time for an address. More...
 
LeasedAddress m_leasedAddresses
 Leased address and their status (cache memory) More...
 
Ipv4Address m_maxAddress
 The last address in the address pool. More...
 
Ipv4Address m_minAddress
 The first address in the address pool. More...
 
Ipv4Address m_poolAddress
 The network address available to the server. More...
 
Ipv4Mask m_poolMask
 The network mask of the pool. More...
 
Time m_rebind
 The rebinding time for an address. More...
 
Time m_renew
 The renewal time for an address. More...
 
Ptr< Socketm_socket
 The socket bound to port 67. More...
 

Static Private Attributes

static const int PORT = 67
 Port number of DHCP server. More...
 

Additional Inherited Members

- Public Types inherited from ns3::Application
typedef void(* DelayAddressCallback) (const Time &delay, const Address &from)
 Common callback signature for packet delay and address. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

Detailed Description

Implements the functionality of a DHCP server.

Config Paths

ns3::DhcpServer is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/ApplicationList/[i]/$ns3::DhcpServer"

Attributes

  • LeaseTime: Lease for which address will be leased.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +3e+10ns
    • Flags: construct write read
  • RenewTime: Time after which client should renew.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +1.5e+10ns
    • Flags: construct write read
  • RebindTime: Time after which client should rebind.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +2.5e+10ns
    • Flags: construct write read
  • PoolAddresses: Pool of addresses to provide on request.
  • FirstAddress: The First valid address that can be given.
  • LastAddress: The Last valid address that can be given.
  • PoolMask: Mask of the pool of addresses.
    • Set with class: Ipv4MaskValue
    • Underlying type: Ipv4Mask
    • Initial value: 102.102.102.102
    • Flags: construct write read
  • Gateway: Address of default gateway

Attributes defined in parent class ns3::Application

  • StartTime: Time at which the application will start
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • StopTime: Time at which the application will stop
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 280 bytes (on a 64-bit architecture).

Definition at line 45 of file dhcp-server.h.

Member Typedef Documentation

◆ AvailableAddress

Available address container - IP addr.

Definition at line 131 of file dhcp-server.h.

◆ ExpiredAddress

Expired address container - chaddr.

Definition at line 124 of file dhcp-server.h.

◆ ExpiredAddressCIter

typedef std::list<Address>::const_iterator ns3::DhcpServer::ExpiredAddressCIter
private

Expired address const iterator - chaddr.

Definition at line 128 of file dhcp-server.h.

◆ ExpiredAddressIter

Expired address iterator - chaddr.

Definition at line 126 of file dhcp-server.h.

◆ LeasedAddress

typedef std::map<Address, std::pair<Ipv4Address, uint32_t> > ns3::DhcpServer::LeasedAddress
private

Leased address container - chaddr + IP addr / lease time.

Definition at line 117 of file dhcp-server.h.

◆ LeasedAddressCIter

typedef std::map<Address, std::pair<Ipv4Address, uint32_t> >::const_iterator ns3::DhcpServer::LeasedAddressCIter
private

Leased address const iterator - chaddr + IP addr / lease time.

Definition at line 121 of file dhcp-server.h.

◆ LeasedAddressIter

typedef std::map<Address, std::pair<Ipv4Address, uint32_t> >::iterator ns3::DhcpServer::LeasedAddressIter
private

Leased address iterator - chaddr + IP addr / lease time.

Definition at line 119 of file dhcp-server.h.

Constructor & Destructor Documentation

◆ DhcpServer()

ns3::DhcpServer::DhcpServer ( )

Definition at line 93 of file dhcp-server.cc.

References NS_LOG_FUNCTION.

◆ ~DhcpServer()

ns3::DhcpServer::~DhcpServer ( )
virtual

Definition at line 98 of file dhcp-server.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddStaticDhcpEntry()

void ns3::DhcpServer::AddStaticDhcpEntry ( Address  chaddr,
Ipv4Address  addr 
)

Add a static entry to the pool.

Parameters
chaddrThe client chaddr.
addrThe address to handle to the client.

Definition at line 386 of file dhcp-server.cc.

References ns3::Address::CopyFrom(), ns3::Address::CopyTo(), ns3::Ipv4Address::Get(), m_availableAddresses, m_leasedAddresses, m_maxAddress, m_minAddress, ns3::Address::MAX_SIZE, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::DhcpServer::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Application.

Definition at line 104 of file dhcp-server.cc.

References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 43 of file dhcp-server.cc.

References m_gateway, m_lease, m_maxAddress, m_minAddress, m_poolAddress, m_poolMask, m_rebind, m_renew, ns3::MakeIpv4AddressAccessor(), ns3::MakeIpv4AddressChecker(), ns3::MakeIpv4MaskAccessor(), ns3::MakeIpv4MaskChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Referenced by ns3::DhcpHelper::DhcpHelper().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ NetHandler()

void ns3::DhcpServer::NetHandler ( Ptr< Socket socket)
private

◆ SendAck()

void ns3::DhcpServer::SendAck ( Ptr< NetDevice iDev,
DhcpHeader  header,
InetSocketAddress  from 
)
private

◆ SendOffer()

◆ StartApplication()

◆ StopApplication()

void ns3::DhcpServer::StopApplication ( void  )
privatevirtual

Stops the DHCP client application.

Reimplemented from ns3::Application.

Definition at line 171 of file dhcp-server.cc.

References ns3::EventId::Cancel(), m_expiredEvent, m_leasedAddresses, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ TimerHandler()

void ns3::DhcpServer::TimerHandler ( void  )
private

Modifies the remaining lease time of addresses.

Definition at line 184 of file dhcp-server.cc.

References m_expiredAddresses, m_expiredEvent, m_leasedAddresses, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by StartApplication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_availableAddresses

AvailableAddress ns3::DhcpServer::m_availableAddresses
private

Available addresses to be used (IP addresses)

Definition at line 135 of file dhcp-server.h.

Referenced by AddStaticDhcpEntry(), SendOffer(), and StartApplication().

◆ m_expiredAddresses

ExpiredAddress ns3::DhcpServer::m_expiredAddresses
private

Expired addresses to be reused (chaddr of the clients)

Definition at line 134 of file dhcp-server.h.

Referenced by SendOffer(), and TimerHandler().

◆ m_expiredEvent

EventId ns3::DhcpServer::m_expiredEvent
private

The Event to trigger TimerHandler.

Definition at line 139 of file dhcp-server.h.

Referenced by StartApplication(), StopApplication(), and TimerHandler().

◆ m_gateway

Ipv4Address ns3::DhcpServer::m_gateway
private

The gateway address.

Definition at line 114 of file dhcp-server.h.

Referenced by GetTypeId(), and SendOffer().

◆ m_lease

Time ns3::DhcpServer::m_lease
private

The granted lease time for an address.

Definition at line 136 of file dhcp-server.h.

Referenced by GetTypeId(), SendAck(), and SendOffer().

◆ m_leasedAddresses

LeasedAddress ns3::DhcpServer::m_leasedAddresses
private

Leased address and their status (cache memory)

Definition at line 133 of file dhcp-server.h.

Referenced by AddStaticDhcpEntry(), SendAck(), SendOffer(), StartApplication(), StopApplication(), and TimerHandler().

◆ m_maxAddress

Ipv4Address ns3::DhcpServer::m_maxAddress
private

The last address in the address pool.

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

Referenced by AddStaticDhcpEntry(), GetTypeId(), NetHandler(), and StartApplication().

◆ m_minAddress

Ipv4Address ns3::DhcpServer::m_minAddress
private

The first address in the address pool.

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

Referenced by AddStaticDhcpEntry(), GetTypeId(), NetHandler(), and StartApplication().

◆ m_poolAddress

Ipv4Address ns3::DhcpServer::m_poolAddress
private

The network address available to the server.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_poolMask

Ipv4Mask ns3::DhcpServer::m_poolMask
private

The network mask of the pool.

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

Referenced by GetTypeId(), SendOffer(), and StartApplication().

◆ m_rebind

Time ns3::DhcpServer::m_rebind
private

The rebinding time for an address.

Definition at line 138 of file dhcp-server.h.

Referenced by GetTypeId(), and SendOffer().

◆ m_renew

Time ns3::DhcpServer::m_renew
private

The renewal time for an address.

Definition at line 137 of file dhcp-server.h.

Referenced by GetTypeId(), and SendOffer().

◆ m_socket

Ptr<Socket> ns3::DhcpServer::m_socket
private

The socket bound to port 67.

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

Referenced by NetHandler(), SendAck(), SendOffer(), StartApplication(), and StopApplication().

◆ PORT

const int ns3::DhcpServer::PORT = 67
staticprivate

Port number of DHCP server.

Definition at line 70 of file dhcp-server.h.

Referenced by StartApplication().


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