CircuitBreakerState.h

Go to the documentation of this file.

#pragma once
 
#include "QGCState.h"
 
#include <QtCore/QElapsedTimer>
 
#include <functional>
 
class CircuitBreakerState : public QGCState
{
    Q_OBJECT
    Q_DISABLE_COPY(CircuitBreakerState)
 
public:
    using Action = std::function<bool()>;
 
    enum class State {
        Closed,     
        Open,       
        HalfOpen    
    };
    Q_ENUM(State)
 
    
    CircuitBreakerState(const QString& stateName, QState* parent,
                        Action action, int failureThreshold = 5,
                        int resetTimeoutMsecs = 30000);
 
    State circuitState() const { return _circuitState; }
 
    int failureCount() const { return _failureCount; }
 
    int failureThreshold() const { return _failureThreshold; }
 
    void reset();
 
    bool isTripped() const { return _circuitState == State::Open; }
 
signals:
    void tripped();
 
    void circuitReset();
 
    void succeeded();
 
    void failed();
 
protected:
    void onEnter() override;
 
private:
    Action _action;
    int _failureThreshold;
    int _resetTimeoutMsecs;
 
    State _circuitState = State::Closed;
    int _failureCount = 0;
    QElapsedTimer _tripTimer;
};