ctrl_dhcp4_srv.h

Go to the documentation of this file.

// Copyright (C) 2012-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef CTRL_DHCPV4_SRV_H
#define CTRL_DHCPV4_SRV_H
 
#include <asiolink/asio_wrapper.h>
#include <asiolink/asiolink.h>
#include <cc/data.h>
#include <cc/command_interpreter.h>
#include <util/reconnect_ctl.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/timer_mgr.h>
#include <dhcp4/dhcp4_srv.h>
 
namespace isc {
namespace dhcp {

class ControlledDhcpv4Srv : public isc::dhcp::Dhcpv4Srv {
public:

    ControlledDhcpv4Srv(uint16_t server_port = DHCP4_SERVER_PORT,
                        uint16_t client_port = 0);

    virtual ~ControlledDhcpv4Srv();

    void init(const std::string& config_file);

    isc::data::ConstElementPtr
    loadConfigFile(const std::string& file_name);

    void cleanup();

    virtual void shutdownServer(int exit_value);

    bool getShutdown() const;

    static isc::data::ConstElementPtr
    processConfig(isc::data::ConstElementPtr config);

    static isc::data::ConstElementPtr
    checkConfig(isc::data::ConstElementPtr config);

    static isc::data::ConstElementPtr
    finishConfigHookLibraries(isc::data::ConstElementPtr config);

    static ControlledDhcpv4Srv* getInstance() {
        return (server_);
    }
 
protected:
    static void sessionReader(void);

    isc::data::ConstElementPtr
    commandShutdownHandler(const std::string& command,
                           isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigReloadHandler(const std::string& command,
                               isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigGetHandler(const std::string& command,
                            isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigHashGetHandler(const std::string& command,
                                isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigWriteHandler(const std::string& command,
                              isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigSetHandler(const std::string& command,
                            isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigTestHandler(const std::string& command,
                             isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandDhcpDisableHandler(const std::string& command,
                              isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandDhcpEnableHandler(const std::string& command,
                             isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandInterfaceListHandler(const std::string& command,
                                isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandInterfaceRedetectHandler(const std::string& command,
                                    isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandInterfaceAddHandler(const std::string& command,
                               isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandVersionGetHandler(const std::string& command,
                             isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandBuildReportHandler(const std::string& command,
                              isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandLeasesReclaimHandler(const std::string& command,
                                isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandSubnet4SelectTestHandler(const std::string& command,
                                    isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandSubnet4o6SelectTestHandler(const std::string& command,
                                      isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandServerTagGetHandler(const std::string& command,
                               isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandConfigBackendPullHandler(const std::string& command,
                                    isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandStatusGetHandler(const std::string& command,
                            isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandStatisticSetMaxSampleCountAllHandler(const std::string& command,
                                                isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandStatisticSetMaxSampleAgeAllHandler(const std::string& command,
                                              isc::data::ConstElementPtr args);

    isc::data::ConstElementPtr
    commandLfcStartHandler(const std::string& command,
                           isc::data::ConstElementPtr args);
 
private:
    void reclaimExpiredLeases(const size_t max_leases, const uint16_t timeout,
                              const bool remove_lease,
                              const uint16_t max_unwarned_cycles);

    void deleteExpiredReclaimedLeases(const uint32_t secs);

    bool dbLostCallback(util::ReconnectCtlPtr db_reconnect_ctl);

    bool dbRecoveredCallback(util::ReconnectCtlPtr db_reconnect_ctl);

    bool dbFailedCallback(util::ReconnectCtlPtr db_reconnect_ctl);

    void openSocketsFailedCallback(util::ReconnectCtlPtr reconnect_ctl);

    void cbFetchUpdates(const SrvConfigPtr& srv_cfg,
                        boost::shared_ptr<unsigned> failure_count);

    static ControlledDhcpv4Srv* server_;

    TimerMgrPtr timer_mgr_;
};
 
}  // namespace dhcp
}  // namespace isc
 
#endif