GNU Radio 3.4.2 C++ API
|
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_types.h> 00026 00027 class gr_timer; 00028 00029 typedef boost::shared_ptr<gr_timer> gr_timer_sptr; 00030 00031 typedef void (*gr_timer_hook)(gr_timer *, void *); 00032 00033 /*! 00034 * \brief create a timeout. 00035 * 00036 * \ingroup misc 00037 * gr_timer_hook is called when timer fires. 00038 */ 00039 gr_timer_sptr gr_make_timer (gr_timer_hook, void *); 00040 00041 /*! 00042 * \brief implement timeouts 00043 */ 00044 class gr_timer { 00045 double d_expiry; 00046 double d_period; 00047 gr_timer_hook d_hook; 00048 void *d_hook_arg; 00049 00050 friend gr_timer_sptr gr_make_timer (gr_timer_hook, void *); 00051 00052 gr_timer (...); 00053 00054 public: 00055 ~gr_timer (); 00056 00057 //! return absolute current time (seconds since the epoc). 00058 static double now (); 00059 00060 /*! 00061 * \brief schedule timer to fire at abs_when 00062 * \param abs_when absolute time in seconds since the epoc. 00063 */ 00064 void schedule_at (double abs_when); 00065 00066 /*! 00067 * \brief schedule timer to fire rel_when seconds from now. 00068 * \param rel_when relative time in seconds from now. 00069 */ 00070 void schedule_after (double rel_when); // relative time in seconds 00071 00072 /*! 00073 * \brief schedule a periodic timeout. 00074 * \param abs_when absolute time to fire first time 00075 * \param period time between firings 00076 */ 00077 void schedule_periodic (double abs_when, double period); 00078 00079 //! cancel timer 00080 void unschedule (); 00081 }; 00082 00083 #endif /* INCLUDED_GR_TIMER_H */