query_filter.h

Go to the documentation of this file.

// Copyright (C) 2018-2020 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 QUERY_FILTER_H
#define QUERY_FILTER_H

#include <ha_config.h>
#include <dhcp/pkt4.h>
#include <dhcp/pkt6.h>

#include <boost/scoped_ptr.hpp>

#include <cstdint>
#include <map>
#include <mutex>
#include <set>
#include <string>
#include <vector>

namespace isc {
namespace ha {

class QueryFilter {
public:

    explicit QueryFilter(const HAConfigPtr& config);

    void serveScope(const std::string& scope_name);

    void serveScopeOnly(const std::string& scope_name);

    void serveScopes(const std::vector<std::string>& scopes);

    void serveDefaultScopes();

    void serveFailoverScopes();

    void serveNoScopes();

    bool amServingScope(const std::string& scope_name) const;

    std::set<std::string> getServedScopes() const;

    bool inScope(const dhcp::Pkt4Ptr& query4, std::string& scope_class) const;

    bool inScope(const dhcp::Pkt6Ptr& query6, std::string& scope_class) const;

private:
    void serveScopeInternal(const std::string& scope_name);

    void serveScopeOnlyInternal(const std::string& scope_name);

    void serveScopesInternal(const std::vector<std::string>& scopes);

    void serveDefaultScopesInternal();

    void serveFailoverScopesInternal();

    void serveNoScopesInternal();

    bool amServingScopeInternal(const std::string& scope_name) const;

    std::set<std::string> getServedScopesInternal() const;

    template<typename QueryPtrType>
    bool inScopeInternal(const QueryPtrType& query, std::string& scope_class) const;

protected:

    int loadBalance(const dhcp::Pkt4Ptr& query4) const;

    int loadBalance(const dhcp::Pkt6Ptr& query6) const;

    uint8_t loadBalanceHash(const uint8_t* key, const size_t key_len) const;

    void validateScopeName(const std::string& scope_name) const;

    std::string makeScopeClass(const std::string& scope_name) const;

    HAConfigPtr config_;

    std::vector<HAConfig::PeerConfigPtr> peers_;

    std::map<std::string, bool> scopes_;

    int active_servers_;

    boost::scoped_ptr<std::mutex> mutex_;
};

} // end of namespace isc::ha
} // end of namespace isc

#endif // QUERY_FILTER_H