ping_context_store.h

Go to the documentation of this file.

// Copyright (C) 2023-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 PING_CONTEXT_STORE_H
#define PING_CONTEXT_STORE_H
 
#include <asiolink/io_address.h>
#include <ping_context.h>
 
#include <boost/multi_index/indexed_by.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/composite_key.hpp>
#include <boost/scoped_ptr.hpp>
 
#include <mutex>
#include <vector>
 
namespace isc {
namespace ping_check {

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

struct AddressIndexTag { };

struct QueryIndexTag { };

struct NextToSendIndexTag { };

struct ExpirationIndexTag { };

struct StateIndexTag { };

typedef boost::multi_index_container<
    // It holds pointers to Lease6 objects.
    PingContextPtr,
    boost::multi_index::indexed_by<
        // Specification of the first index starts here.
        // This index sorts PingContexts by IPv4 addresses represented as
        // IOAddress objects.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<AddressIndexTag>,
            boost::multi_index::const_mem_fun<PingContext, const isc::asiolink::IOAddress&,
                                              &PingContext::getTarget>
        >,
 
        // Specification of the second index starts here.
        // This index sorts contexts by query.
        boost::multi_index::ordered_unique<
            boost::multi_index::tag<QueryIndexTag>,
            boost::multi_index::const_mem_fun<PingContext, isc::dhcp::Pkt4Ptr,
                                              &PingContext::getQuery>
        >,
 
        // Specification of the third index starts here.
        // This index sorts contexts by send_wait_start.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<NextToSendIndexTag>,
            boost::multi_index::composite_key<
                PingContext,
                // The boolean value specifying if context is waiting to send
                boost::multi_index::const_mem_fun<PingContext, bool,
                                                  &PingContext::isWaitingToSend>,
                // Context expiration time.
                boost::multi_index::const_mem_fun<PingContext, const TimeStamp&,
                                                  &PingContext::getSendWaitStart>
            >
        >,
 
        // Specification of the fourth index starts here.
        // This index sorts contexts by next_expiry.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<ExpirationIndexTag>,
            boost::multi_index::composite_key<
                PingContext,
                // The boolean value specifying if context is waiting for a reply
                boost::multi_index::const_mem_fun<PingContext, bool,
                                                  &PingContext::isWaitingForReply>,
                // Context expiration time.
                boost::multi_index::const_mem_fun<PingContext, const TimeStamp&,
                                                  &PingContext::getNextExpiry>
            >
        >,
 
        // Specification of the fifth index starts here.
        // This index sorts contexts by State.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<StateIndexTag>,
            boost::multi_index::const_mem_fun<PingContext, PingContext::State,
                                              &PingContext::getState>
        >
    >
> PingContextContainer;

typedef std::vector<PingContextPtr> PingContextCollection;
typedef boost::shared_ptr<PingContextCollection> PingContextCollectionPtr;

class PingContextStore {
public:

    PingContextStore() : pings_(), mutex_(new std::mutex) {
    }

    ~PingContextStore() = default;

    PingContextPtr addContext(isc::dhcp::Lease4Ptr& lease,
                              isc::dhcp::Pkt4Ptr& query,
                              uint32_t min_echos,
                              uint32_t reply_timeout,
                              isc::hooks::ParkingLotHandlePtr& parking_lot
                              = PingContext::EMPTY_LOT());

    void updateContext(const PingContextPtr& context);

    void deleteContext(const PingContextPtr& context);

    PingContextPtr getContextByAddress(const isc::asiolink::IOAddress& address);

    PingContextPtr getContextByQuery(isc::dhcp::Pkt4Ptr& query);

    PingContextPtr getNextToSend();

    PingContextPtr getExpiresNext();

    PingContextCollectionPtr getExpiredSince(const TimeStamp& since = PingContext::now());

    PingContextCollectionPtr getAll();

    void clear();
 
private:
    PingContextContainer pings_;

    const boost::scoped_ptr<std::mutex> mutex_;
};
 
} // end of namespace ping_check
} // end of namespace isc
 
#endif