2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_time_lib.h
23 * @brief functions related to time
25 * @author Christian Grothoff
28 #ifndef GNUNET_TIME_LIB_H
29 #define GNUNET_TIME_LIB_H
34 #if 0 /* keep Emacsens' auto-indent happy */
39 #include "gnunet_common.h"
42 * Time for absolute times used by GNUnet, in milliseconds.
44 struct GNUNET_TIME_Absolute
53 * Time for relative time used by GNUnet, in milliseconds.
54 * Always positive, so we can only refer to future time.
56 struct GNUNET_TIME_Relative
66 * Time for relative time used by GNUnet, in milliseconds and in network byte order.
68 struct GNUNET_TIME_RelativeNBO
71 * The actual value (in network byte order).
73 uint64_t rel_value__ GNUNET_PACKED;
78 * Time for absolute time used by GNUnet, in milliseconds and in network byte order.
80 struct GNUNET_TIME_AbsoluteNBO
83 * The actual value (in network byte order).
85 uint64_t abs_value__ GNUNET_PACKED;
92 #define GNUNET_TIME_UNIT_ZERO GNUNET_TIME_relative_get_zero()
97 #define GNUNET_TIME_UNIT_ZERO_ABS GNUNET_TIME_absolute_get_zero()
100 * One millisecond, our basic time unit.
102 #define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_unit()
107 #define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 1000)
112 #define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 60)
117 #define GNUNET_TIME_UNIT_HOURS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
122 #define GNUNET_TIME_UNIT_DAYS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_HOURS, 24)
127 #define GNUNET_TIME_UNIT_WEEKS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 7)
130 * One month (30 days).
132 #define GNUNET_TIME_UNIT_MONTHS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 30)
135 * One year (365 days).
137 #define GNUNET_TIME_UNIT_YEARS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 365)
140 * Constant used to specify "forever". This constant
141 * will be treated specially in all time operations.
143 #define GNUNET_TIME_UNIT_FOREVER_REL GNUNET_TIME_relative_get_forever ()
146 * Constant used to specify "forever". This constant
147 * will be treated specially in all time operations.
149 #define GNUNET_TIME_UNIT_FOREVER_ABS GNUNET_TIME_absolute_get_forever ()
152 * Return relative time of 0ms.
154 struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_zero (void);
157 * Return absolute time of 0ms.
159 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_zero (void);
162 * Return relative time of 1ms.
164 struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_unit (void);
169 struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_forever (void);
174 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_forever (void);
177 * Get the current time.
179 * @return the current time
181 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get (void);
184 * Convert relative time to an absolute time in the
187 * @param rel relative time to convert
188 * @return timestamp that is "rel" in the future, or FOREVER if rel==FOREVER (or if we would overflow)
190 struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute (struct
195 * Return the minimum of two relative time values.
197 * @param t1 first timestamp
198 * @param t2 other timestamp
199 * @return timestamp that is smaller
201 struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
205 GNUNET_TIME_Relative t2);
209 * Return the maximum of two relative time values.
211 * @param t1 first timestamp
212 * @param t2 other timestamp
213 * @return timestamp that is larger
215 struct GNUNET_TIME_Relative GNUNET_TIME_relative_max (struct
219 GNUNET_TIME_Relative t2);
222 * Return the minimum of two absolute time values.
224 * @param t1 first timestamp
225 * @param t2 other timestamp
226 * @return timestamp that is smaller
228 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_min (struct
232 GNUNET_TIME_Absolute t2);
235 * Return the maximum of two absolute time values.
237 * @param t1 first timestamp
238 * @param t2 other timestamp
239 * @return timestamp that is smaller
241 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_max (struct
245 GNUNET_TIME_Absolute t2);
248 * Given a timestamp in the future, how much time
249 * remains until then?
251 * @param future some absolute time, typically in the future
252 * @return future - now, or 0 if now >= future, or FOREVER if future==FOREVER.
254 struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining (struct
260 * Calculate the estimate time of arrival/completion
263 * @param start when did the operation start?
264 * @param finished how much has been done?
265 * @param total how much must be done overall (same unit as for "finished")
266 * @return remaining duration for the operation,
267 * assuming it continues at the same speed
269 struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
275 * Compute the time difference between the given start and end times.
276 * Use this function instead of actual subtraction to ensure that
277 * "FOREVER" and overflows are handeled correctly.
279 * @param start some absolute time
280 * @param end some absolute time (typically larger or equal to start)
281 * @return 0 if start >= end; FOREVER if end==FOREVER; otherwise end - start
283 struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_difference (struct
291 * Get the duration of an operation as the
292 * difference of the current time and the given start time "hence".
294 * @param hence some absolute time, typically in the past
295 * @return aborts if hence==FOREVER, 0 if hence > now, otherwise now-hence.
297 struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration (struct
303 * Add a given relative duration to the
306 * @param start some absolute time
307 * @param duration some relative time to add
308 * @return FOREVER if either argument is FOREVER or on overflow; start+duration otherwise
310 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add (struct
319 * Subtract a given relative duration from the
322 * @param start some absolute time
323 * @param duration some relative time to subtract
324 * @return ZERO if start <= duration, or FOREVER if start time is FOREVER; start-duration otherwise
326 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_subtract (struct
334 * Multiply relative time by a given factor.
336 * @param rel some duration
337 * @param factor integer to multiply with
338 * @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
340 struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply (struct
347 * Divide relative time by a given factor.
349 * @param rel some duration
350 * @param factor integer to divide by
351 * @return FOREVER if rel=FOREVER or factor==0; otherwise rel/factor
353 struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide (struct
360 * Add relative times together.
362 * @param a1 some relative time
363 * @param a2 some other relative time
364 * @return FOREVER if either argument is FOREVER or on overflow; a1+a2 otherwise
366 struct GNUNET_TIME_Relative GNUNET_TIME_relative_add (struct
367 GNUNET_TIME_Relative a1,
373 * Subtract relative timestamp from the other.
375 * @param a1 first timestamp
376 * @param a2 second timestamp
377 * @return ZERO if a2>=a1 (including both FOREVER), FOREVER if a1 is FOREVER, a1-a2 otherwise
379 struct GNUNET_TIME_Relative
380 GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
381 struct GNUNET_TIME_Relative a2);
385 * Convert relative time to network byte order.
387 * @param a time to convert
388 * @return converted time value
390 struct GNUNET_TIME_RelativeNBO GNUNET_TIME_relative_hton (struct
395 * Convert relative time from network byte order.
397 * @param a time to convert
398 * @return converted time value
400 struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh (struct
401 GNUNET_TIME_RelativeNBO
405 * Convert relative time to network byte order.
407 * @param a time to convert
408 * @return converted time value
410 struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton (struct
415 * Convert relative time from network byte order.
417 * @param a time to convert
418 * @return converted time value
420 struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh (struct
421 GNUNET_TIME_AbsoluteNBO
424 #if 0 /* keep Emacsens' auto-indent happy */
431 /* ifndef GNUNET_TIME_LIB_H */
433 /* end of gnunet_time_lib.h */