TimeoutCounter.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_APP_LEDGER_TIMEOUTCOUNTER_H_INCLUDED
#define RIPPLE_APP_LEDGER_TIMEOUTCOUNTER_H_INCLUDED
 
#include <xrpld/app/main/Application.h>
#include <xrpld/core/Job.h>
#include <xrpl/beast/clock/abstract_clock.h>
#include <xrpl/beast/utility/Journal.h>
#include <boost/asio/basic_waitable_timer.hpp>
#include <mutex>
 
namespace ripple {
 
class TimeoutCounter
{
public:
    virtual void
    cancel();
 
protected:
    using ScopedLockType = std::unique_lock<std::recursive_mutex>;
 
    struct QueueJobParameter
    {
        JobType jobType;
        std::string jobName;
        std::optional<std::uint32_t> jobLimit;
    };
 
    TimeoutCounter(
        Application& app,
        uint256 const& targetHash,
        std::chrono::milliseconds timeoutInterval,
        QueueJobParameter&& jobParameter,
        beast::Journal journal);
 
    virtual ~TimeoutCounter() = default;
 
    void
    setTimer(ScopedLockType&);
 
    void
    queueJob(ScopedLockType&);
 
    virtual void
    onTimer(bool progress, ScopedLockType&) = 0;
 
    virtual std::weak_ptr<TimeoutCounter>
    pmDowncast() = 0;
 
    bool
    isDone() const
    {
        return complete_ || failed_;
    }
 
    // Used in this class for access to boost::asio::io_service and
    // ripple::Overlay. Used in subtypes for the kitchen sink.
    Application& app_;
    beast::Journal journal_;
    mutable std::recursive_mutex mtx_;
 
    uint256 const hash_;
    int timeouts_;
    bool complete_;
    bool failed_;
    bool progress_;
    std::chrono::milliseconds timerInterval_;
 
    QueueJobParameter queueJobParameter_;
 
private:
    void
    invokeOnTimer();
 
    boost::asio::basic_waitable_timer<std::chrono::steady_clock> timer_;
};
 
}  // namespace ripple
 
#endif