reconnect_ctl.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 RECONNECT_CTL_H
#define RECONNECT_CTL_H
 
#include <string>
#include <boost/shared_ptr.hpp>
 
namespace isc {
namespace util {
 
enum class OnFailAction {
    STOP_RETRY_EXIT,
    SERVE_RETRY_EXIT,
    SERVE_RETRY_CONTINUE
};
 
class ReconnectCtl {
public:
    ReconnectCtl(const std::string& backend_type, const std::string& timer_name,
                 unsigned int max_retries, unsigned int retry_interval,
                 OnFailAction action, unsigned int id) :
          backend_type_(backend_type), timer_name_(timer_name),
          max_retries_(max_retries), retries_left_(max_retries),
          retry_interval_(retry_interval), action_(action), id_(id) {
    }
 
    std::string backendType() const {
        return (backend_type_);
    }
 
    unsigned int id() const {
        return (id_);
    }
 
    std::string timerName() const {
        return (timer_name_);
    }
 
    bool checkRetries() {
        return (retries_left_ ? --retries_left_ : false);
    }
 
    unsigned int maxRetries() const {
        return (max_retries_);
    }
 
    unsigned int retriesLeft() const {
        return (retries_left_);
    }
 
    unsigned int retryIndex() const {
        return (max_retries_ - retries_left_);
    }
 
    unsigned int retryInterval() const {
        return (retry_interval_);
    }
 
    void resetRetries() {
        retries_left_ = max_retries_;
    }
 
    bool alterServiceState() const {
        return (action_ == OnFailAction::STOP_RETRY_EXIT);
    }
 
    bool exitOnFailure() const {
        return ((action_ == OnFailAction::STOP_RETRY_EXIT) ||
                (action_ == OnFailAction::SERVE_RETRY_EXIT));
    }
 
    static std::string onFailActionToText(OnFailAction action);
 
    static OnFailAction onFailActionFromText(const std::string& text);
 
private:
 
    const std::string backend_type_;
 
    std::string timer_name_;
 
    unsigned int max_retries_;
 
    unsigned int retries_left_;
 
    unsigned int retry_interval_;
 
    OnFailAction action_;
 
    unsigned int id_;
};
 
typedef boost::shared_ptr<ReconnectCtl> ReconnectCtlPtr;
 
}
}
 
#endif // RECONNECT_CTL_H