Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
update the comments of that file
[simgrid.git] / src / include / xbt / xbt_os_time.h
1 /*  xbt/xbt_os_timer.h -- system dependency on time functions               */
2
3 /* Copyright (c) 2007, 2009-2010, 2012-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef _XBT_OS_TIMER_H
10 #define _XBT_OS_TIMER_H
11
12 #include <xbt/misc.h>           /* XBT_PUBLIC */
13
14 /** @brief get time in seconds 
15
16   * gives  the  number  of  seconds since the Epoch (00:00:00 UTC, January 1, 1970).
17   */
18 XBT_PUBLIC(double) xbt_os_time(void);
19 XBT_PUBLIC(void) xbt_os_sleep(double sec);
20
21 typedef struct s_xbt_os_timer *xbt_os_timer_t;
22
23 XBT_PUBLIC(xbt_os_timer_t) xbt_os_timer_new(void);
24 XBT_PUBLIC(void) xbt_os_timer_free(xbt_os_timer_t timer);
25 XBT_PUBLIC(double) xbt_os_timer_elapsed(xbt_os_timer_t timer);
26 XBT_PUBLIC(size_t) xbt_os_timer_size(void);
27
28 XBT_PUBLIC(void) xbt_os_walltimer_start(xbt_os_timer_t timer);
29 XBT_PUBLIC(void) xbt_os_walltimer_resume(xbt_os_timer_t timer);
30 XBT_PUBLIC(void) xbt_os_walltimer_stop(xbt_os_timer_t timer);
31
32 XBT_PUBLIC(void) xbt_os_cputimer_start(xbt_os_timer_t timer);
33 XBT_PUBLIC(void) xbt_os_cputimer_resume(xbt_os_timer_t timer);
34 XBT_PUBLIC(void) xbt_os_cputimer_stop(xbt_os_timer_t timer);
35
36 XBT_PUBLIC(void) xbt_os_threadtimer_start(xbt_os_timer_t timer);
37 XBT_PUBLIC(void) xbt_os_threadtimer_resume(xbt_os_timer_t timer);
38 XBT_PUBLIC(void) xbt_os_threadtimer_stop(xbt_os_timer_t timer);
39 #endif