x11_timer.hpp

Go to the documentation of this file.

/*****************************************************************************
 * x11_timer.hpp
 *****************************************************************************
 * Copyright (C) 2003 the VideoLAN team
 * $Id$
 *
 * Authors: Cyril Deguet     <asmax@via.ecp.fr>
 *          Olivier Teulière <ipkiss@via.ecp.fr>
 *
 * 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 Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifndef X11_TIMER_HPP
#define X11_TIMER_HPP

#include "../src/os_timer.hpp"

#include <list>

// Forward declaration
class X11TimerLoop;
class CmdGeneric;


// X11 specific timer
class X11Timer: public OSTimer
{
    public:
        X11Timer( intf_thread_t *pIntf, CmdGeneric &rCmd );
        virtual ~X11Timer();

        /// (Re)start the timer with the given delay (in ms). If oneShot is
        /// true, stop it after the first execution of the callback.
        virtual void start( int delay, bool oneShot );

        /// Stop the timer
        virtual void stop();

        mtime_t getNextDate() const;

        /// Execute the callback.
        /// Returns false if the timer must be removed after
        bool execute();

    private:
        /// Command to execute
        CmdGeneric &m_rCommand;
        /// Timer loop
        X11TimerLoop *m_pTimerLoop;
        /// Delay between two execute
        mtime_t m_interval;
        /// Next date at which the timer must be executed
        mtime_t m_nextDate;
        /// Flag to tell if the timer must be stopped after the first execution
        bool m_oneShot;
};


/// Class to manage a set of timers
class X11TimerLoop: public SkinObject
{
    public:
        /// Create the timer loop with the communication number of the X11
        /// display
        X11TimerLoop( intf_thread_t *pIntf, int connectionNumber );
        virtual ~X11TimerLoop();

        /// Add a timer in the manager
        void addTimer( X11Timer &rTimer );

        /// Remove a timer from the manager
        void removeTimer( X11Timer &rTimer );

        /// Wait for the next timer and execute it
        void waitNextTimer();

    private:
        /// Connection number of the X11 display
        int m_connectionNumber;
        /// List of timers
        list<X11Timer*> m_timers;

        /// Sleep for delay milliseconds, unless an X11 event is received
        /// Returns true if the sleep has been interupted.
        bool sleep( int delay );
};


#endif

---