host_cache_impl.h

Go to the documentation of this file.

// Copyright (C) 2018-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 HOST_CACHE_IMPL_H
#define HOST_CACHE_IMPL_H
 
#include <exceptions/exceptions.h>
#include <cc/data.h>
#include <asiolink/io_address.h>
#include <dhcpsrv/base_host_data_source.h>
#include <dhcpsrv/host.h>
#include <dhcpsrv/subnet_id.h>
#include <container.h>
#include <boost/shared_ptr.hpp>
#include <vector>
 
namespace isc {
namespace host_cache {

class HostCacheImpl {
public:

    HostCacheImpl();

    virtual ~HostCacheImpl();

    size_t maximum_;

    void setMaximum(size_t maximum) {
        maximum_ = maximum;
    }

    size_t getMaximum() const {
        return (maximum_);
    }

    dhcp::ConstHostPtr get4(const dhcp::SubnetID& subnet_id,
                            const dhcp::Host::IdentifierType& identifier_type,
                            const uint8_t* identifier_begin,
                            const size_t identifier_len);

    dhcp::ConstHostPtr get4(const dhcp::SubnetID& subnet_id,
                            const asiolink::IOAddress& address);

    dhcp::ConstHostPtr get6(const dhcp::SubnetID& subnet_id,
                            const dhcp::Host::IdentifierType& identifier_type,
                            const uint8_t* identifier_begin,
                            const size_t identifier_len);

    dhcp::ConstHostPtr get6(const asiolink::IOAddress& prefix,
                            const uint8_t prefix_len);

    dhcp::ConstHostPtr get6(const dhcp::SubnetID& subnet_id,
                            const asiolink::IOAddress& address);

    HostContainerSequencedIndex::iterator
    getHostInternal(const dhcp::SubnetID& subnet_id, const bool subnet6,
                    const dhcp::Host::IdentifierType& identifier_type,
                    const uint8_t* identifier,
                    const size_t identifier_len);

    HostContainerSequencedIndex::iterator
    getHostInternal4(const dhcp::SubnetID& subnet_id,
                     const asiolink::IOAddress& address);

    // host is found.
    dhcp::HostPtr
    getHostInternal6(const asiolink::IOAddress& prefix,
                     const uint8_t prefix_len);

    dhcp::HostPtr
    getHostInternal6(const dhcp::SubnetID& subnet_id,
                     const asiolink::IOAddress& address);

    bool add(const dhcp::HostPtr& host);

    std::string del4(const dhcp::SubnetID& subnet_id,
                     const asiolink::IOAddress& addr);

    std::string del4(const dhcp::SubnetID& subnet_id,
                     const dhcp::Host::IdentifierType& identifier_type,
                     const uint8_t* identifier_begin,
                     const size_t identifier_len);

    std::string del6(const dhcp::SubnetID& subnet_id,
                     const asiolink::IOAddress& addr);

    std::string del6(const dhcp::SubnetID& subnet_id,
                     const dhcp::Host::IdentifierType& identifier_type,
                     const uint8_t* identifier_begin,
                     const size_t identifier_len);

    dhcp::HostPtr relocate(dhcp::HostPtr host);

    data::ElementPtr toElement() const;

    size_t insert(const dhcp::ConstHostPtr& host, bool overwrite);

    void update(isc::dhcp::ConstHostPtr const& host);

    bool insertResv6(const dhcp::HostPtr& host);

    bool remove(const dhcp::HostPtr& host);

    void removeResv6(const dhcp::HostPtr& host);

    void clear() {
        cache_.clear();
        cache6_.clear();
    }

    void flush(size_t count);

    size_t size() const {
        return (cache_.size());
    }

    size_t capacity() const {
        return (maximum_);
    }

    virtual dhcp::ConstHostCollection
    get(const dhcp::Host::IdentifierType& identifier_type,
        const uint8_t* identifier_begin,
        const size_t identifier_len) const;
 
private:

    HostContainer cache_;

    Resv6Container cache6_;
};
 
} // end of namespace isc::host_cache
} // end of namespace isc
 
#endif