IntervalTimer.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_IntervalTimer_hxx
#define __ccxx_IntervalTimer_hxx

#include <commonc++/Common.h++>
#include <commonc++/SystemException.h++>

#ifdef CCXX_OS_POSIX
#include <signal.h>
#include <time.h>
#endif

namespace ccxx {

class COMMONCPP_API IntervalTimer
{
  public:

  virtual ~IntervalTimer() throw();

  void start() throw(SystemException);

  void stop() throw();

  inline uint_t getInitialDelay() const throw()
  { return(_initialDelay); }

  inline void setInitialDelay(uint_t initialDelay) throw()
  { _initialDelay = initialDelay; }

  inline uint_t getInterval() const throw()
  { return(_interval); }

  inline void setInterval(uint_t interval) throw()
  { _interval = interval; }

  inline bool isRunning() const throw()
  { return(_running); }

  protected:

  IntervalTimer(uint_t initialDelay, uint_t interval = 0);

  virtual void fired() = 0;

  private:

#ifdef CCXX_OS_WINDOWS
  static void CALLBACK _callback(LPVOID arg, DWORD timerLowValue,
                                 DWORD timerHighValue);
#else
  static void _callback(union sigval data);
#endif

  uint_t _initialDelay;
  uint_t _interval;
  bool _running;

#if defined(CCXX_OS_WINDOWS)
  HANDLE _timer;
#elif ! defined(CCXX_OS_MACOSX)
  timer_t _timer;
  struct sigevent _event;
#endif
};

}; // namespace ccxx

#endif // __ccxx_IntervalTimer_hxx

/* end of header file */