glib/gtimer.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_TIMER_H__
  28 #define __G_TIMER_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gtypes.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* Timer
  39  */
  40
  41 /* microseconds per second */
  42 typedef struct _GTimer          GTimer;
  43
  44 #define G_USEC_PER_SEC 1000000
  45
  46 GLIB_AVAILABLE_IN_ALL
  47 GTimer*  g_timer_new             (void);
  48 GLIB_AVAILABLE_IN_ALL
  49 void     g_timer_destroy         (GTimer      *timer);
  50 GLIB_AVAILABLE_IN_ALL
  51 void     g_timer_start           (GTimer      *timer);
  52 GLIB_AVAILABLE_IN_ALL
  53 void     g_timer_stop            (GTimer      *timer);
  54 GLIB_AVAILABLE_IN_ALL
  55 void     g_timer_reset           (GTimer      *timer);
  56 GLIB_AVAILABLE_IN_ALL
  57 void     g_timer_continue        (GTimer      *timer);
  58 GLIB_AVAILABLE_IN_ALL
  59 gdouble  g_timer_elapsed         (GTimer      *timer,
  60                                   gulong      *microseconds);
  61 GLIB_AVAILABLE_IN_2_62
  62 gboolean g_timer_is_active       (GTimer      *timer);
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 void     g_usleep                (gulong       microseconds);
  66
  67 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  68 GLIB_DEPRECATED_IN_2_62
  69 void     g_time_val_add          (GTimeVal    *time_,
  70                                   glong        microseconds);
  71 GLIB_DEPRECATED_IN_2_62_FOR(g_date_time_new_from_iso8601)
  72 gboolean g_time_val_from_iso8601 (const gchar *iso_date,
  73                                   GTimeVal    *time_);
  74 GLIB_DEPRECATED_IN_2_62_FOR(g_date_time_format)
  75 gchar*   g_time_val_to_iso8601   (GTimeVal    *time_) G_GNUC_MALLOC;
  76 G_GNUC_END_IGNORE_DEPRECATIONS
  77
  78 G_END_DECLS
  79
  80 #endif /* __G_TIMER_H__ */