bulk_lease_query.h

Go to the documentation of this file.

// Copyright (C) 2022-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 BULK_LEASE_QUERY_H
#define BULK_LEASE_QUERY_H
 
#include <config.h>
 
#include <blq_msg.h>
#include <boost/enable_shared_from_this.hpp>
#include <functional>
 
namespace isc {
namespace lease_query {

typedef std::function<void ()> BlqPostCbArg;

typedef std::function<void (const BlqPostCbArg&)> BlqPostCb;

typedef std::function<bool (BlqResponsePtr)> BlqPushToSendCb;

typedef std::function<void (Xid)> BlqQueryCompleteCb;

class BulkLeaseQuery;

typedef boost::shared_ptr<BulkLeaseQuery> BulkLeaseQueryPtr;

class BulkLeaseQuery : public boost::enable_shared_from_this<BulkLeaseQuery> {
public:

    BulkLeaseQuery(BlqQueryPtr query,
                   const BlqPostCb& post,
                   const BlqPushToSendCb& push_to_send,
                   const BlqQueryCompleteCb& query_complete)
        : query_(query), post_(post), push_to_send_(push_to_send),
          query_complete_(query_complete), started_(false), done_(false) {
        if (!query) {
            isc_throw(BadValue, "BulkLeaseQuery query is null");
        }
    }

    virtual ~BulkLeaseQuery() {
    }

    virtual void init() = 0;

    virtual void start() = 0;

    static void processStart(BulkLeaseQueryPtr ptr) {
        if (!ptr) {
            // Should not happen.
            return;
        }
        ptr->start();
    }

    bool isProcessing() const {
        return (started_);
    }

    bool isProcessed() const {
        return (done_);
    }

    BlqQueryPtr getQuery() {
        return (query_);
    }

    uint8_t getQueryType() const {
        return (query_type_);
    }

    Xid getXid() const {
        return (query_->getXid());
    }
 
protected:
    virtual void setDone() {
        done_ = true;
        query_complete_(query_->getXid());
    }

    BlqQueryPtr query_;

    BlqPostCb post_;

    BlqPushToSendCb push_to_send_;

    BlqQueryCompleteCb query_complete_;

    uint8_t query_type_;

    bool started_;

    bool done_;
};
 
} // end of namespace isc::lease_query
} // end of namespace isc
 
#endif // BULK_LEASE_QUERY_H