ping_check_config.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_CHECK_CONFIG_H
#define PING_CHECK_CONFIG_H
 
#include <cc/data.h>
#include <cc/simple_parser.h>
 
namespace isc {
namespace ping_check {

class PingCheckConfig {
public:
    static const data::SimpleKeywords CONFIG_KEYWORDS;

    PingCheckConfig();

    ~PingCheckConfig() = default;

    void parse(data::ConstElementPtr config);

    bool getEnablePingCheck() const {
        return (enable_ping_check_);
    };

    void setEnablePingCheck(bool value) {
        enable_ping_check_ = value;
    }

    uint32_t getMinPingRequests() const {
        return (min_ping_requests_);
    };

    void setMinPingRequests(uint32_t value) {
        min_ping_requests_ = value;
    }

    uint32_t getReplyTimeout() const {
        return (reply_timeout_);
    }

    void setReplyTimeout(uint32_t value) {
        reply_timeout_ = value;
    }

    uint32_t getPingClttSecs() const {
        return (ping_cltt_secs_);
    }

    void setPingClttSecs(uint32_t value) {
        ping_cltt_secs_ = value;
    }

    uint32_t getPingChannelThreads() const {
        return (ping_channel_threads_);
    }

    void setPingChannelThreads(uint32_t value) {
        ping_channel_threads_ = value;
    }
 
private:
    // @brief True if checking is enabled.
    bool enable_ping_check_;

    uint32_t min_ping_requests_;

    uint32_t reply_timeout_;

    uint32_t ping_cltt_secs_;

    size_t ping_channel_threads_;
};

typedef boost::shared_ptr<PingCheckConfig> PingCheckConfigPtr;
 
} // end of namespace ping_check
} // end of namespace isc
 
#endif