/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+ (C) 2001-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
/**
* @file include/gnunet_time_lib.h
* @brief functions related to time
- *
* @author Christian Grothoff
+ * @defgroup time Time and time calculations
+ * @{
*/
#ifndef GNUNET_TIME_LIB_H
#include "gnunet_common.h"
/**
- * Time for absolute times used by GNUnet, in milliseconds.
+ * Time for absolute times used by GNUnet, in microseconds.
*/
struct GNUNET_TIME_Absolute
{
/**
* The actual value.
*/
- uint64_t abs_value;
+ uint64_t abs_value_us;
};
/**
- * Time for relative time used by GNUnet, in milliseconds.
+ * Time for relative time used by GNUnet, in microseconds.
* Always positive, so we can only refer to future time.
*/
struct GNUNET_TIME_Relative
/**
* The actual value.
*/
- uint64_t rel_value;
+ uint64_t rel_value_us;
};
+GNUNET_NETWORK_STRUCT_BEGIN
/**
- * Time for relative time used by GNUnet, in milliseconds and in network byte order.
+ * Time for relative time used by GNUnet, in microseconds and in network byte order.
*/
struct GNUNET_TIME_RelativeNBO
{
/**
* The actual value (in network byte order).
*/
- uint64_t rel_value__ GNUNET_PACKED;
+ uint64_t rel_value_us__ GNUNET_PACKED;
};
/**
- * Time for absolute time used by GNUnet, in milliseconds and in network byte order.
+ * Time for absolute time used by GNUnet, in microseconds and in network byte order.
*/
struct GNUNET_TIME_AbsoluteNBO
{
/**
* The actual value (in network byte order).
*/
- uint64_t abs_value__ GNUNET_PACKED;
+ uint64_t abs_value_us__ GNUNET_PACKED;
};
-
+GNUNET_NETWORK_STRUCT_END
/**
* Relative time zero.
*/
-#define GNUNET_TIME_UNIT_ZERO GNUNET_TIME_relative_get_zero()
+#define GNUNET_TIME_UNIT_ZERO GNUNET_TIME_relative_get_zero_()
/**
* Absolute time zero.
*/
-#define GNUNET_TIME_UNIT_ZERO_ABS GNUNET_TIME_absolute_get_zero()
+#define GNUNET_TIME_UNIT_ZERO_ABS GNUNET_TIME_absolute_get_zero_()
+
+/**
+ * One microsecond, our basic time unit.
+ */
+#define GNUNET_TIME_UNIT_MICROSECONDS GNUNET_TIME_relative_get_unit_()
/**
- * One millisecond, our basic time unit.
+ * One millisecond.
*/
-#define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_unit()
+#define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_millisecond_()
/**
* One second.
*/
-#define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 1000)
+#define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_get_second_()
/**
* One minute.
*/
-#define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 60)
+#define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_get_minute_()
/**
* One hour.
*/
-#define GNUNET_TIME_UNIT_HOURS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
+#define GNUNET_TIME_UNIT_HOURS GNUNET_TIME_relative_get_hour_()
/**
* One day.
* Constant used to specify "forever". This constant
* will be treated specially in all time operations.
*/
-#define GNUNET_TIME_UNIT_FOREVER_REL GNUNET_TIME_relative_get_forever ()
+#define GNUNET_TIME_UNIT_FOREVER_REL GNUNET_TIME_relative_get_forever_ ()
/**
* Constant used to specify "forever". This constant
* will be treated specially in all time operations.
*/
-#define GNUNET_TIME_UNIT_FOREVER_ABS GNUNET_TIME_absolute_get_forever ()
+#define GNUNET_TIME_UNIT_FOREVER_ABS GNUNET_TIME_absolute_get_forever_ ()
+
+
+
+/**
+ * Threshold after which exponential backoff should not increase (15 m).
+ */
+#define GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
+
+
+/**
+ * Perform our standard exponential back-off calculation, starting at 1 ms
+ * and then going by a factor of 2 up unto a maximum of 15 m.
+ *
+ * @param r current backoff time, initially zero
+ */
+#define GNUNET_TIME_STD_BACKOFF(r) GNUNET_TIME_relative_min (GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD, \
+ GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_MILLISECONDS, (r)), 2));
/**
* Return relative time of 0ms.
*/
struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_zero (void);
+GNUNET_TIME_relative_get_zero_ (void);
+
/**
* Return absolute time of 0ms.
*/
struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_get_zero (void);
+GNUNET_TIME_absolute_get_zero_ (void);
+
+
+/**
+ * Return relative time of 1 microsecond.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_unit_ (void);
+
/**
* Return relative time of 1ms.
*/
struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_unit (void);
+GNUNET_TIME_relative_get_millisecond_ (void);
+
+
+/**
+ * Return relative time of 1s.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_second_ (void);
+
+
+/**
+ * Return relative time of 1 minute.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_minute_ (void);
+
+
+/**
+ * Return relative time of 1 hour.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_hour_ (void);
+
/**
* Return "forever".
*/
struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_forever (void);
+GNUNET_TIME_relative_get_forever_ (void);
+
/**
* Return "forever".
*/
struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_get_forever (void);
+GNUNET_TIME_absolute_get_forever_ (void);
+
/**
* Get the current time.
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_get (void);
+
/**
* Convert relative time to an absolute time in the
* future.
struct GNUNET_TIME_Absolute
GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel);
+
/**
* Return the minimum of two relative time values.
*
struct GNUNET_TIME_Relative t2);
+
/**
* Return the maximum of two relative time values.
*
GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
struct GNUNET_TIME_Relative t2);
+
/**
* Return the minimum of two absolute time values.
*
GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
struct GNUNET_TIME_Absolute t2);
+
/**
* Return the maximum of two absolute time values.
*
GNUNET_TIME_absolute_max (struct GNUNET_TIME_Absolute t1,
struct GNUNET_TIME_Absolute t2);
+
/**
* Given a timestamp in the future, how much time
* remains until then?
/**
- * Calculate the estimate time of arrival/completion
+ * Calculate the estimate time of arrival/completion
* for an operation.
*
* @param start when did the operation start?
GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start,
struct GNUNET_TIME_Absolute end);
+
/**
* Get the duration of an operation as the
* difference of the current time and the given start time "hence".
GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
struct GNUNET_TIME_Relative duration);
+
/**
* Multiply relative time by a given factor.
*
GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
unsigned int factor);
+
/**
* Divide relative time by a given factor.
*
GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
unsigned int factor);
+
/**
* Add relative times together.
*
GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
struct GNUNET_TIME_Relative a2);
+
/**
* Subtract relative timestamp from the other.
*
/**
* Convert relative time to network byte order.
- *
+ *
* @param a time to convert
* @return converted time value
*/
struct GNUNET_TIME_RelativeNBO
GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a);
+
/**
* Convert relative time from network byte order.
*
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a);
+
/**
* Convert relative time to network byte order.
*
struct GNUNET_TIME_AbsoluteNBO
GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a);
+
/**
* Convert relative time from network byte order.
*
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a);
-/**
- * Convert a relative time to a string.
- * NOT reentrant!
- *
- * @param time the time to print
- *
- * @return string form of the time (as milliseconds)
- */
-const char *
-GNUNET_TIME_relative_to_string (struct GNUNET_TIME_Relative time);
/**
* Set the timestamp offset for this instance.
void
GNUNET_TIME_set_offset (long long offset);
+
+/**
+ * Get the timestamp offset for this instance.
+ *
+ * @return the offset we currently skew the locale time by
+ */
+long long
+GNUNET_TIME_get_offset (void);
+
+
+/**
+ * Return the current year (i.e. '2011').
+ */
+unsigned int
+GNUNET_TIME_get_current_year (void);
+
+
+/**
+ * Convert a year to an expiration time of January 1st of that year.
+ *
+ * @param year a year (after 1970, please ;-)).
+ * @return absolute time for January 1st of that year.
+ */
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_year_to_time (unsigned int year);
+
+
+/**
+ * Convert an expiration time to the respective year (rounds)
+ *
+ * @param at absolute time
+ * @return year a year (after 1970), 0 on error
+ */
+unsigned int
+GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
}
#endif
+/** @} */ /* end of group time */
+
+
/* ifndef GNUNET_TIME_LIB_H */
#endif
/* end of gnunet_time_lib.h */
projects / oweals / gnunet.git / blobdiff