icinga2/lib/base/timer.h

75 lines
2.4 KiB
C
Raw Normal View History

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
* *
* 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 *
2012-05-11 13:33:57 +02:00
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef TIMER_H
#define TIMER_H
2012-03-28 13:24:49 +02:00
2013-03-16 21:18:53 +01:00
#include "base/i2-base.h"
#include "base/object.h"
#include <boost/signals2.hpp>
2012-03-28 13:24:49 +02:00
namespace icinga {
2013-03-18 11:02:18 +01:00
struct TimerNextExtractor;
2013-02-17 19:14:34 +01:00
/**
* A timer that periodically triggers an event.
2012-05-18 22:21:28 +02:00
*
* @ingroup base
*/
class I2_BASE_API Timer : public Object
2012-03-28 13:24:49 +02:00
{
public:
typedef shared_ptr<Timer> Ptr;
typedef weak_ptr<Timer> WeakPtr;
2012-03-28 13:24:49 +02:00
Timer(void);
void SetInterval(double interval);
double GetInterval(void) const;
2012-03-28 13:24:49 +02:00
2012-09-25 14:03:41 +02:00
static void AdjustTimers(double adjustment);
2012-03-28 13:24:49 +02:00
void Start(void);
void Stop(void);
2013-02-17 19:14:34 +01:00
void Reschedule(double next = -1);
double GetNext(void) const;
2012-03-28 13:24:49 +02:00
2013-03-16 21:18:53 +01:00
boost::signals2::signal<void(const Timer::Ptr&)> OnTimerExpired;
2013-02-19 23:02:08 +01:00
static void Initialize(void);
static void Uninitialize(void);
private:
double m_Interval; /**< The interval of the timer. */
double m_Next; /**< When the next event should happen. */
2013-02-18 14:40:24 +01:00
bool m_Started; /**< Whether the timer is enabled. */
2013-03-04 15:52:42 +01:00
void Call();
2013-02-17 19:14:34 +01:00
static void TimerThreadProc(void);
friend struct TimerNextExtractor;
2012-03-28 13:24:49 +02:00
};
}
#endif /* TIMER_H */