GNU Radio 3.5.1 C++ API
gr_timer.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 #ifndef INCLUDED_GR_TIMER_H
00023 #define INCLUDED_GR_TIMER_H
00024 
00025 #include <gr_core_api.h>
00026 #include <gr_types.h>
00027 
00028 class gr_timer;
00029 
00030 typedef boost::shared_ptr<gr_timer> gr_timer_sptr;
00031 
00032 GR_CORE_API typedef void (*gr_timer_hook)(gr_timer *, void *);
00033 
00034 /*!
00035  * \brief create a timeout.
00036  *
00037  * \ingroup misc
00038  * gr_timer_hook is called when timer fires.
00039  */
00040 GR_CORE_API gr_timer_sptr gr_make_timer (gr_timer_hook, void *);
00041 
00042 /*!
00043  * \brief implement timeouts
00044  */
00045 class GR_CORE_API gr_timer {
00046   double        d_expiry;
00047   double        d_period;
00048   gr_timer_hook d_hook;
00049   void         *d_hook_arg;
00050 
00051   friend GR_CORE_API gr_timer_sptr gr_make_timer (gr_timer_hook, void *);
00052 
00053   gr_timer (...);
00054 
00055 public:
00056   ~gr_timer ();
00057 
00058   //! return absolute current time (seconds since the epoc).
00059   static double now ();
00060   
00061   /*!
00062    * \brief schedule timer to fire at abs_when
00063    * \param abs_when    absolute time in seconds since the epoc.
00064    */
00065   void schedule_at (double abs_when);
00066 
00067   /*!
00068    * \brief schedule timer to fire rel_when seconds from now.
00069    * \param rel_when    relative time in seconds from now.
00070    */
00071   void schedule_after (double rel_when);        // relative time in seconds
00072 
00073   /*!
00074    * \brief schedule a periodic timeout.
00075    * \param abs_when    absolute time to fire first time
00076    * \param period      time between firings
00077    */
00078   void schedule_periodic (double abs_when, double period);
00079 
00080   //! cancel timer
00081   void unschedule ();
00082 };
00083 
00084 #endif /* INCLUDED_GR_TIMER_H */