command_creator.h

Go to the documentation of this file.

// Copyright (C) 2018-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 HA_COMMAND_CREATOR_H
#define HA_COMMAND_CREATOR_H
 
#include <cc/data.h>
#include <dhcpsrv/lease.h>
#include <high_availability/ha_server_type.h>
#include <high_availability/lease_update_backlog.h>
 
#include <string>
#include <unordered_set>
 
namespace isc {
namespace ha {

class CommandCreator {
public:

    static data::ConstElementPtr
    createDHCPDisable(const unsigned int origin_id,
                      const unsigned int max_period,
                      const HAServerType& server_type);

    static data::ConstElementPtr
    createDHCPEnable(const unsigned int origin_id,
                     const HAServerType& server_type);

    static data::ConstElementPtr
    createHAReset(const std::string& server_name,
                  const HAServerType& server_type);

    static data::ConstElementPtr
    createHeartbeat(const std::string& server_name,
                    const HAServerType& server_type);

    static data::ConstElementPtr
    createLease4Update(const dhcp::Lease4& lease4);

    static data::ConstElementPtr
    createLease4Delete(const dhcp::Lease4& lease4);

    static data::ConstElementPtr
    createLease4GetAll();

    static data::ConstElementPtr
    createLease4GetPage(const dhcp::Lease4Ptr& lease4,
                        const uint32_t limit);

    static data::ConstElementPtr
    createLease6BulkApply(const dhcp::Lease6CollectionPtr& leases,
                          const dhcp::Lease6CollectionPtr& deleted_leases);

    static data::ConstElementPtr
    createLease6BulkApply(LeaseUpdateBacklog& leases);

    static data::ConstElementPtr
    createLease6Update(const dhcp::Lease6& lease6);

    static data::ConstElementPtr
    createLease6Delete(const dhcp::Lease6& lease6);

    static data::ConstElementPtr
    createLease6GetAll();

    static data::ConstElementPtr
    createLease6GetPage(const dhcp::Lease6Ptr& lease6,
                        const uint32_t limit);

    static data::ConstElementPtr
    createMaintenanceNotify(const std::string& server_name,
                            const bool cancel,
                            const int state,
                            const HAServerType& server_type);

    static data::ConstElementPtr
    createSyncCompleteNotify(const unsigned int origin_id,
                             const std::string& server_name,
                             const HAServerType& server_type);

    static std::unordered_set<std::string> ha_commands4_;

    static std::unordered_set<std::string> ha_commands6_;
 
private:

    static void insertLeaseExpireTime(data::ElementPtr& lease);

    static void
    insertService(data::ConstElementPtr& command,
                  const HAServerType& server_type);
};
 
} // end of namespace ha
} // end of namespace isc
 
#endif