git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/runtime/gr_timer.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22 #ifndef INCLUDED_GR_TIMER_H
  23 #define INCLUDED_GR_TIMER_H
  24
  25 #include <gr_types.h>
  26
  27 class gr_timer;
  28
  29 typedef boost::shared_ptr<gr_timer> gr_timer_sptr;
  30
  31 typedef void (*gr_timer_hook)(gr_timer *, void *);
  32
  33 /*!
  34  * \brief create a timeout.
  35  *
  36  * \ingroup misc
  37  * gr_timer_hook is called when timer fires.
  38  */
  39 gr_timer_sptr gr_make_timer (gr_timer_hook, void *);
  40
  41 /*!
  42  * \brief implement timeouts
  43  */
  44 class gr_timer {
  45   double        d_expiry;
  46   double        d_period;
  47   gr_timer_hook d_hook;
  48   void         *d_hook_arg;
  49
  50   friend gr_timer_sptr gr_make_timer (gr_timer_hook, void *);
  51
  52   gr_timer (...);
  53
  54 public:
  55   ~gr_timer ();
  56
  57   //! return absolute current time (seconds since the epoc).
  58   static double now ();
  59
  60   /*!
  61    * \brief schedule timer to fire at abs_when
  62    * \param abs_when    absolute time in seconds since the epoc.
  63    */
  64   void schedule_at (double abs_when);
  65
  66   /*!
  67    * \brief schedule timer to fire rel_when seconds from now.
  68    * \param rel_when    relative time in seconds from now.
  69    */
  70   void schedule_after (double rel_when);        // relative time in seconds
  71
  72   /*!
  73    * \brief schedule a periodic timeout.
  74    * \param abs_when    absolute time to fire first time
  75    * \param period      time between firings
  76    */
  77   void schedule_periodic (double abs_when, double period);
  78
  79   //! cancel timer
  80   void unschedule ();
  81 };
  82
  83 #endif /* INCLUDED_GR_TIMER_H */