icinga2/lib/base/timer.hpp

75 lines
2.5 KiB
C++

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef TIMER_H
#define TIMER_H
#include "base/i2-base.hpp"
#include "base/object.hpp"
#include <boost/signals2.hpp>
namespace icinga {
class TimerHolder;
/**
* A timer that periodically triggers an event.
*
* @ingroup base
*/
class Timer final : public Object
{
public:
DECLARE_PTR_TYPEDEFS(Timer);
~Timer() override;
static void Uninitialize();
void SetInterval(double interval);
double GetInterval() const;
static void AdjustTimers(double adjustment);
void Start();
void Stop(bool wait = false);
void Reschedule(double next = -1);
double GetNext() const;
boost::signals2::signal<void(const Timer::Ptr&)> OnTimerExpired;
private:
double m_Interval{0}; /**< The interval of the timer. */
double m_Next{0}; /**< When the next event should happen. */
bool m_Started{false}; /**< Whether the timer is enabled. */
bool m_Running{false}; /**< Whether the timer proc is currently running. */
void Call();
void InternalReschedule(bool completed, double next = -1);
static void TimerThreadProc();
friend class TimerHolder;
};
}
#endif /* TIMER_H */