Dogcows Code - chaz/tint2/blob - src/util/timer.h

   1 /**************************************************************************
   2 *
   3 * Copyright (C) 2009 Andreas.Fink (Andreas.Fink85@gmail.com)
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License version 2
   7 * as published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope that it will be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 * GNU General Public License for more details.
  13 * You should have received a copy of the GNU General Public License
  14 * along with this program; if not, write to the Free Software
  15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 **************************************************************************/
  17
  18
  19 #ifndef TIMER_H
  20 #define TIMER_H
  21
  22 #include <glib.h>
  23
  24 extern GSList* timeout_list;
  25 extern struct timeval next_timeout;
  26
  27
  28 struct timeout {
  29         int interval_msec;
  30         struct timespec timeout_expires;
  31         void (*_callback)();
  32         void* arg;
  33 };
  34
  35
  36 // timer functions
  37 /** installs a timeout with the first timeout of 'value_msec' and then a periodic timeout with
  38         * 'interval_msec'. '_callback' is the callback function when the timer reaches the timeout.
  39         * returns a pointer to the timeout, which is needed for stopping it again **/
  40 const struct timeout* add_timeout(int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
  41
  42 void change_timeout(const struct timeout* t, int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
  43
  44 /** stops the timeout 't' **/
  45 void stop_timeout(const struct timeout* t);
  46
  47 /** stops all timeouts **/
  48 void stop_all_timeouts();
  49
  50 void update_next_timeout();
  51 void callback_timeout_expired();
  52
  53 #endif // TIMER_H