d2_update_mgr.h

Go to the documentation of this file.

// Copyright (C) 2013-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 D2_UPDATE_MGR_H
#define D2_UPDATE_MGR_H

 
#include <asiolink/io_service.h>
#include <d2/d2_queue_mgr.h>
#include <d2srv/nc_trans.h>
#include <d2srv/d2_cfg_mgr.h>
#include <d2srv/d2_log.h>
#include <exceptions/exceptions.h>
 
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/indexed_by.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
#include <map>
 
namespace isc {
namespace d2 {

class D2UpdateMgrError : public isc::Exception {
public:
    D2UpdateMgrError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

struct SequenceTag { };

struct AddressTag { };

struct FqdnTag { };

typedef boost::multi_index_container<
    // It holds pointers to NameChangeTransactions.
    NameChangeTransactionPtr,
    boost::multi_index::indexed_by<
        // Index by insertion order
        boost::multi_index::sequenced<
            boost::multi_index::tag<SequenceTag>
        >,
 
        // Index by FQDN as dns::Name for case insensitive comparison.
        boost::multi_index::hashed_unique<
            boost::multi_index::tag<FqdnTag>,
            boost::multi_index::const_mem_fun<NameChangeTransaction, std::string,
                                              &NameChangeTransaction::getFqdnLower>
        >,
 
        // Index by lease address
        boost::multi_index::hashed_unique<
            boost::multi_index::tag<AddressTag>,
            boost::multi_index::const_mem_fun<NameChangeTransaction, const asiolink::IOAddress&,
                                              &NameChangeTransaction::getIOAddress>
        >
    >
> TransactionStore;
 
typedef TransactionStore::index<SequenceTag>::type TransactionSequenceIndex;
 
typedef TransactionStore::index<FqdnTag>::type TransactionFqdnIndex;
 
typedef TransactionStore::index<AddressTag>::type TransactionAddressIndex;

class D2UpdateMgr : public boost::noncopyable {
public:
    static const size_t MAX_TRANSACTIONS_DEFAULT = 32;

    D2UpdateMgr(D2QueueMgrPtr& queue_mgr, D2CfgMgrPtr& cfg_mgr,
                asiolink::IOServicePtr& io_service,
                const size_t max_transactions = MAX_TRANSACTIONS_DEFAULT);

    virtual ~D2UpdateMgr();

    void sweep();
 
protected:
    void checkFinishedTransactions();

    void pickNextJob();

    bool makeTransaction(isc::dhcp_ddns::NameChangeRequestPtr& ncr);
 
public:
    const asiolink::IOServicePtr& getIOService() {
        return (io_service_);
    }

    size_t getMaxTransactions() const {
        return (max_transactions_);
    }

    void setMaxTransactions(const size_t max_transactions);

    bool hasTransaction(const dhcp_ddns::NameChangeRequestPtr& ncr) const;

    void clearTransactions();

    size_t getQueueCount() const;

    size_t getTransactionCount() const;

    TransactionSequenceIndex::iterator transactionSequenceBegin();

    TransactionSequenceIndex::iterator transactionSequenceEnd();

    TransactionFqdnIndex::iterator
    findTransactionByFqdn(const std::string& fqdn) const;

    TransactionFqdnIndex::iterator transactionFqdnBegin();

    TransactionFqdnIndex::iterator transactionFqdnEnd();

    TransactionAddressIndex::iterator
    findTransactionByAddress( const asiolink::IOAddress& address) const;

    TransactionAddressIndex::iterator transactionAddressBegin();

    TransactionAddressIndex::iterator transactionAddressEnd();
 
private:
    D2QueueMgrPtr queue_mgr_;

    D2CfgMgrPtr cfg_mgr_;

    asiolink::IOServicePtr io_service_;

    size_t max_transactions_;

    TransactionStore transaction_store_;
};

typedef boost::shared_ptr<D2UpdateMgr> D2UpdateMgrPtr;
 
} // namespace isc::d2
} // namespace isc
#endif