interval_timer.h

Go to the documentation of this file.

// Copyright (C) 2011-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 ASIOLINK_INTERVAL_TIMER_H
#define ASIOLINK_INTERVAL_TIMER_H 1
 
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
#endif
#include <boost/asio/deadline_timer.hpp>
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
 
#include <boost/shared_ptr.hpp>
#include <functional>
 
#include <asiolink/io_service.h>
 
namespace isc {
namespace asiolink {
 
class IntervalTimerImpl;

class IntervalTimer {
public:
    typedef std::function<void()> Callback;

    enum Mode
    {
        REPEATING,
        ONE_SHOT
    };


private:
    IntervalTimer(const IntervalTimer& source);
    IntervalTimer& operator=(const IntervalTimer& source);
public:
    IntervalTimer(const IOServicePtr& io_service);

    ~IntervalTimer();

    void setup(const Callback& cbfunc, const long interval,
               const Mode& mode = REPEATING);

    void cancel();

    long getInterval() const;
 
private:
    boost::shared_ptr<IntervalTimerImpl> impl_;
};
 
typedef boost::shared_ptr<isc::asiolink::IntervalTimer> IntervalTimerPtr;
 
}  // namespace asiolink
}  // namespace isc
 
#endif // ASIOLINK_INTERVAL_TIMER_H