GTimer: move docs from tmpl to .c
[platform/upstream/glib.git] / 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  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library 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 GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
29 #endif
30
31 #ifndef __G_TIMER_H__
32 #define __G_TIMER_H__
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 GTimer*  g_timer_new             (void);
47 void     g_timer_destroy         (GTimer      *timer);
48 void     g_timer_start           (GTimer      *timer);
49 void     g_timer_stop            (GTimer      *timer);
50 void     g_timer_reset           (GTimer      *timer);
51 void     g_timer_continue        (GTimer      *timer);
52 gdouble  g_timer_elapsed         (GTimer      *timer,
53                                   gulong      *microseconds);
54
55 void     g_usleep                (gulong       microseconds);
56
57 void     g_time_val_add          (GTimeVal    *time_, 
58                                   glong        microseconds);
59 gboolean g_time_val_from_iso8601 (const gchar *iso_date,
60                                   GTimeVal    *time_);
61 gchar*   g_time_val_to_iso8601   (GTimeVal    *time_) G_GNUC_MALLOC;
62
63 G_END_DECLS
64
65 #endif /* __G_TIMER_H__ */