GroovX: src/nub/timer.h Source File

00001 
00004 
00005 //
00006 // Copyright (c) 2004-2007 University of Southern California
00007 // Rob Peters <rjpeters at usc dot edu>
00008 //
00009 // created: Thu Oct 14 10:26:11 2004
00010 // commit: $Id: timer.h 10065 2007-04-12 05:54:56Z rjpeters $
00011 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/nub/timer.h $
00012 //
00013 // --------------------------------------------------------------------
00014 //
00015 // This file is part of GroovX.
00016 //   [http://ilab.usc.edu/rjpeters/groovx/]
00017 //
00018 // GroovX is free software; you can redistribute it and/or modify it
00019 // under the terms of the GNU General Public License as published by
00020 // the Free Software Foundation; either version 2 of the License, or
00021 // (at your option) any later version.
00022 //
00023 // GroovX is distributed in the hope that it will be useful, but
00024 // WITHOUT ANY WARRANTY; without even the implied warranty of
00025 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00026 // General Public License for more details.
00027 //
00028 // You should have received a copy of the GNU General Public License
00029 // along with GroovX; if not, write to the Free Software Foundation,
00030 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00031 //
00033 
00034 #ifndef GROOVX_NUB_TIMER_H_UTC20050626084019_DEFINED
00035 #define GROOVX_NUB_TIMER_H_UTC20050626084019_DEFINED
00036 
00037 #include "nub/scheduler.h"
00038 #include "nub/signal.h"
00039 
00040 #include "rutz/shared_ptr.h"
00041 #include "rutz/stopwatch.h"
00042 
00043 namespace nub
00044 {
00045   class timer;
00046 }
00047 
00049 class nub::timer
00050 {
00051 public:
00052   timer(unsigned int msec, bool repeat = false);
00053 
00054   virtual ~timer();
00055 
00056   nub::signal0 sig_timeout;
00057 
00058   void schedule(rutz::shared_ptr<nub::scheduler> s);
00059   void cancel();
00060 
00061   unsigned int delay_msec() const { return m_msec_delay; }
00062   void set_delay_msec(unsigned int msec) { m_msec_delay = msec; }
00063 
00064   bool is_repeating() const { return m_is_repeating; }
00065   void set_repeating(bool repeat) { m_is_repeating = repeat; }
00066 
00067   bool is_pending() const { return m_token.get() != 0; }
00068 
00069   double elapsed_msec() const { return m_stopwatch.elapsed().msec(); }
00070 
00071 private:
00072   static void dummy_callback(void* clientdata);
00073 
00074   timer(const timer&);
00075   timer& operator=(const timer&);
00076 
00077   rutz::shared_ptr<nub::scheduler>   m_scheduler;
00078   rutz::shared_ptr<nub::timer_token> m_token;
00079   unsigned int                       m_msec_delay;
00080   bool                               m_is_repeating;
00081 
00082   // Diagnostics
00083   mutable rutz::stopwatch            m_stopwatch;
00084 };
00085 
00086 static const char __attribute__((used)) vcid_groovx_nub_timer_h_utc20050626084019[] = "$Id: timer.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00087 #endif // !GROOVX_NUB_TIMER_H_UTC20050626084019_DEFINED