Timer.h

/*
 * Copyright (C) 2006-2013 Marc Boris Duerner
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef Pt_System_Timer_h
#define Pt_System_Timer_h

#include <Pt/System/Api.h>
#include <Pt/Signal.h>
#include <Pt/Timespan.h>
#include <cstddef>

namespace Pt {

namespace System {

class PT_SYSTEM_API Timer
{
    class Sentry;

    public:
        Timer();

        ~Timer();

        EventLoop* parent()
        { return _loop; }

        EventLoop* loop()
        { return _loop; }

        void setActive(EventLoop& loop);

        void detach();

        bool isStarted() const;

        std::size_t interval() const;

        void start(std::size_t interval);

        void stop();

        bool update();

        bool update(const Timespan& now);

        Signal<>& timeout()
        { return _timeout; }

        const Timespan& finished() const
        { return _finished; }

    private:
        Sentry*     _sentry;
        EventLoop*  _loop;
        std::size_t _interval;
        Timespan    _finished;
        Signal<>    _timeout;
        void*       _reserved;
};

} // namespace System

} // namespace Pt

#endif // Pt_System_Timer_h