*/
struct GNUNET_TIME_Absolute
{
+ /**
+ * The actual value.
+ */
uint64_t value;
};
*/
struct GNUNET_TIME_Relative
{
+ /**
+ * The actual value.
+ */
uint64_t value;
};
*/
struct GNUNET_TIME_RelativeNBO
{
- uint64_t value GNUNET_PACKED;
+ /**
+ * The actual value (in network byte order).
+ */
+ uint64_t value__ GNUNET_PACKED;
};
*/
struct GNUNET_TIME_AbsoluteNBO
{
- uint64_t value GNUNET_PACKED;
+ /**
+ * The actual value (in network byte order).
+ */
+ uint64_t value__ GNUNET_PACKED;
};
+
/**
- * @brief constants to specify time
+ * Relative time 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()
+
+/**
+ * One millisecond, our basic time unit.
+ */
#define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_unit()
+
+/**
+ * One second.
+ */
#define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 1000)
+
+/**
+ * One minute.
+ */
#define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 60)
+
+/**
+ * One hour.
+ */
#define GNUNET_TIME_UNIT_HOURS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
+
+/**
+ * One day.
+ */
#define GNUNET_TIME_UNIT_DAYS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_HOURS, 24)
+
+/**
+ * One week.
+ */
#define GNUNET_TIME_UNIT_WEEKS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 7)
+
+/**
+ * One month (30 days).
+ */
#define GNUNET_TIME_UNIT_MONTHS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 30)
+
+/**
+ * One year (365 days).
+ */
#define GNUNET_TIME_UNIT_YEARS GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS, 365)
/**
*/
struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_zero (void);
+/**
+ * Return absolute time of 0ms.
+ */
+struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_zero (void);
+
/**
* Return relative time of 1ms.
*/
* Convert relative time to an absolute time in the
* future.
*
+ * @param rel relative time to convert
* @return timestamp that is "rel" in the future, or FOREVER if rel==FOREVER (or if we would overflow)
*/
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute (struct
/**
* Return the minimum of two relative time values.
*
+ * @param t1 first timestamp
+ * @param t2 other timestamp
* @return timestamp that is smaller
*/
struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
struct
GNUNET_TIME_Relative t2);
+
+/**
+ * Return the maximum of two relative time values.
+ *
+ * @param t1 first timestamp
+ * @param t2 other timestamp
+ * @return timestamp that is larger
+ */
+struct GNUNET_TIME_Relative GNUNET_TIME_relative_max (struct
+ GNUNET_TIME_Relative
+ t1,
+ struct
+ GNUNET_TIME_Relative t2);
+
+/**
+ * Return the minimum of two absolute time values.
+ *
+ * @param t1 first timestamp
+ * @param t2 other timestamp
+ * @return timestamp that is smaller
+ */
+struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_min (struct
+ GNUNET_TIME_Absolute
+ t1,
+ struct
+ GNUNET_TIME_Absolute t2);
+
+/**
+ * Return the maximum of two absolute time values.
+ *
+ * @param t1 first timestamp
+ * @param t2 other timestamp
+ * @return timestamp that is smaller
+ */
+struct GNUNET_TIME_Absolute 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?
*
+ * @param future some absolute time, typically in the future
* @return future - now, or 0 if now >= future, or FOREVER if future==FOREVER.
*/
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining (struct
GNUNET_TIME_Absolute
future);
+
+/**
+ * Calculate the estimate time of arrival/completion
+ * for an operation.
+ *
+ * @param start when did the operation start?
+ * @param finished how much has been done?
+ * @param total how much must be done overall (same unit as for "finished")
+ * @return remaining duration for the operation,
+ * assuming it continues at the same speed
+ */
+struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
+ uint64_t finished,
+ uint64_t total);
+
+
/**
* Compute the time difference between the given start and end times.
* Use this function instead of actual subtraction to ensure that
* "FOREVER" and overflows are handeled correctly.
*
+ * @param start some absolute time
+ * @param end some absolute time (typically larger or equal to start)
* @return 0 if start >= end; FOREVER if end==FOREVER; otherwise end - start
*/
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_difference (struct
* Get the duration of an operation as the
* difference of the current time and the given start time "hence".
*
+ * @param hence some absolute time, typically in the past
* @return aborts if hence==FOREVER, 0 if hence > now, otherwise now-hence.
*/
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration (struct
* Add a given relative duration to the
* given start time.
*
+ * @param start some absolute time
+ * @param duration some relative time to add
* @return FOREVER if either argument is FOREVER or on overflow; start+duration otherwise
*/
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add (struct
GNUNET_TIME_Relative
duration);
+
+/**
+ * Subtract a given relative duration from the
+ * given start time.
+ *
+ * @param start some absolute time
+ * @param duration some relative time to subtract
+ * @return ZERO if start <= duration, or FOREVER if start time is FOREVER; start-duration otherwise
+ */
+struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_subtract (struct
+ GNUNET_TIME_Absolute
+ start,
+ struct
+ GNUNET_TIME_Relative
+ duration);
+
/**
* Multiply relative time by a given factor.
*
+ * @param rel some duration
+ * @param factor integer to multiply with
* @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
*/
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply (struct
unsigned int
factor);
+/**
+ * Divide relative time by a given factor.
+ *
+ * @param rel some duration
+ * @param factor integer to divide by
+ * @return FOREVER if rel=FOREVER or factor==0; otherwise rel/factor
+ */
+struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide (struct
+ GNUNET_TIME_Relative
+ rel,
+ unsigned int
+ factor);
+
/**
* Add relative times together.
*
+ * @param a1 some relative time
+ * @param a2 some other relative time
* @return FOREVER if either argument is FOREVER or on overflow; a1+a2 otherwise
*/
struct GNUNET_TIME_Relative GNUNET_TIME_relative_add (struct
GNUNET_TIME_Relative
a2);
+/**
+ * Subtract relative timestamp from the other.
+ *
+ * @param a1 first timestamp
+ * @param a2 second timestamp
+ * @return ZERO if a2>=a1 (including both FOREVER), FOREVER if a1 is FOREVER, a1-a2 otherwise
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
+ struct GNUNET_TIME_Relative a2);
+
/**
* 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
/**
* Convert relative time from network byte order.
+ *
+ * @param a time to convert
+ * @return converted time value
*/
struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh (struct
GNUNET_TIME_RelativeNBO
/**
* Convert relative time to network byte order.
+ *
+ * @param a time to convert
+ * @return converted time value
*/
struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton (struct
GNUNET_TIME_Absolute
/**
* Convert relative time from network byte order.
+ *
+ * @param a time to convert
+ * @return converted time value
*/
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh (struct
GNUNET_TIME_AbsoluteNBO
projects / oweals / gnunet.git / blobdiff