lease_query_impl4.h

Go to the documentation of this file.

// Copyright (C) 2020-2025 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 LEASE_QUERY_IMPL4_H
#define LEASE_QUERY_IMPL4_H
 
#include <config.h>
 
#include <dhcp/pkt4.h>
#include <dhcpsrv/cfg_option.h>
#include <dhcpsrv/lease.h>
#include <dhcpsrv/subnet.h>
#include <lease_query_impl.h>
 
namespace isc {
namespace lease_query {

class LeaseQueryImpl4 : public LeaseQueryImpl {
public:
    LeaseQueryImpl4(const data::ConstElementPtr config);

    virtual ~LeaseQueryImpl4(){};

    virtual void processQuery(dhcp::PktPtr base_query) const;

    static dhcp::DHCPMessageType queryByIpAddress(const asiolink::IOAddress& ciaddr,
                                                  dhcp::Lease4Collection& leases);

    static dhcp::DHCPMessageType queryByClientId(const dhcp::ClientIdPtr& client_id,
                                                 dhcp::Lease4Collection& leases);

    static dhcp::DHCPMessageType queryByHWAddr(const dhcp::HWAddrPtr& hwaddr,
                                               dhcp::Lease4Collection& leases);

    static dhcp::Lease4Collection winnowLeases(const dhcp::Lease4Collection& leases);

    static dhcp::Pkt4Ptr buildResponse(dhcp::DHCPMessageType response_type,
                                       const dhcp::Pkt4Ptr& query,
                                       const dhcp::Lease4Collection& leases);

    static dhcp::Pkt4Ptr initResponse(dhcp::DHCPMessageType response_type,
                                      const dhcp::Pkt4Ptr& query);

    static void addAssociatedLeases(dhcp::Pkt4Ptr response,
                                    const dhcp::Lease4Collection& leases);

    static void addOptions(const dhcp::Pkt4Ptr& query, dhcp::Pkt4Ptr response,
                           const dhcp::Lease4Ptr& lease);

    static void addLeaseTimes(dhcp::Pkt4Ptr response, const dhcp::Lease4Ptr& lease,
                              const dhcp::Subnet4Ptr& subnet);

    static void addRelayAgentInfo(dhcp::Pkt4Ptr response, const dhcp::Lease4Ptr& lease);

    static void sendResponse(const dhcp::Pkt4Ptr& response);

    static std::string leaseQueryLabel(const dhcp::Pkt4Ptr& packet);

    static bool acceptServerId(const dhcp::Pkt4Ptr& query,
                               dhcp::OptionPtr& server_id_opt);

    static void buildCfgOptionList(dhcp::CfgOptionList& co_list,
                                   const dhcp::Pkt4Ptr& query,
                                   const dhcp::Lease4Ptr& lease = dhcp::Lease4Ptr(),
                                   const dhcp::Subnet4Ptr& subnet = dhcp::Subnet4Ptr());

    static void appendServerId(dhcp::Pkt4Ptr& response, dhcp::CfgOptionList& co_list);

    static int upgradeHandler(hooks::CalloutHandle& handle);
};

typedef boost::shared_ptr<LeaseQueryImpl4> LeaseQueryImpl4Ptr;
 
} // end of namespace isc::lease_query
} // end of namespace isc
 
#endif // LEASE_QUERY_IMPL4_H