path: root/src/utils/timer.h

/*
 *  The Mana Server
 *  Copyright (C) 2004-2010  The Mana World Development Team
 *
 *  This file is part of The Mana Server.
 *
 *  The Mana Server 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
 *  any later version.
 *
 *  The Mana Server 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 The Mana Server.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef TIMER_H
#define TIMER_H

/* I need a 64-bit unsigned integer */
#ifdef _MSC_VER
   typedef __uint64 uint64_t // when using MSVC use its internal type
#else
   #include <cstdint> // on other compilers use the C++11 official header
#endif

namespace utils
{

/**
 * This class is for timing purpose as a replacement for SDL_TIMER
 */
class Timer
{
    public:
        /**
         * Constructor.
         *
         * @param ms           the interval in milliseconds
         */
        Timer(unsigned ms);

        /**
         * Returns the number of elapsed ticks since last call.
         */
        int poll();

        /**
         * Sleeps till the next tick occurs.
         */
        void sleep();

        /**
         * Activates the timer.
         */
        void start();

        /**
         * Deactivates the timer.
         */
        void stop();

        /**
         * Changes the interval between two pulses.
         */
        void changeInterval(unsigned newinterval);

    private:
        /**
         * Interval between two pulses.
         */
        unsigned interval;

        /**
         * The time the last pulse occured.
         */
        uint64_t lastpulse;

        /**
         * Activity status of the timer.
         */
        bool active;
};

} // ::utils

#endif