-note duplicate API
[oweals/gnunet.git] / src / include / gnunet_time_lib.h
index 3b901f52658387e99302d429d0a9de56a7a33a44..fe5c0880434fed6670ea49565753249fe9ced0e4 100644 (file)
@@ -46,7 +46,7 @@ struct GNUNET_TIME_Absolute
   /**
    * The actual value.
    */
-  uint64_t value;
+  uint64_t abs_value;
 };
 
 /**
@@ -58,9 +58,10 @@ struct GNUNET_TIME_Relative
   /**
    * The actual value.
    */
-  uint64_t value;
+  uint64_t rel_value;
 };
 
+GNUNET_NETWORK_STRUCT_BEGIN
 
 /**
  * Time for relative time used by GNUnet, in milliseconds and in network byte order.
@@ -70,7 +71,7 @@ struct GNUNET_TIME_RelativeNBO
   /**
    * The actual value (in network byte order).
    */
-  uint64_t value__ GNUNET_PACKED;
+  uint64_t rel_value__ GNUNET_PACKED;
 };
 
 
@@ -82,39 +83,39 @@ struct GNUNET_TIME_AbsoluteNBO
   /**
    * The actual value (in network byte order).
    */
-  uint64_t value__ GNUNET_PACKED;
+  uint64_t abs_value__ 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 millisecond, our basic time unit.
  */
-#define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_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)
+#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.
@@ -140,45 +141,79 @@ struct GNUNET_TIME_AbsoluteNBO
  * 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_ ()
+
 
 /**
  * Return relative time of 0ms.
  */
-struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_zero (void);
+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);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_get_zero_ (void);
+
 
 /**
  * Return relative time of 1ms.
  */
-struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_unit (void);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_unit_ (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);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_forever_ (void);
+
 
 /**
  * Return "forever".
  */
-struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_forever (void);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_get_forever_ (void);
+
 
 /**
  * Get the current time.
  *
  * @return the current time
  */
-struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get (void);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_get (void);
+
 
 /**
  * Convert relative time to an absolute time in the
@@ -187,9 +222,9 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get (void);
  * @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
-                                                              GNUNET_TIME_Relative
-                                                              rel);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel);
+
 
 /**
  * Return the minimum of two relative time values.
@@ -198,11 +233,47 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute (struct
  * @param t2 other timestamp
  * @return timestamp that is smaller
  */
-struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
-                                                     GNUNET_TIME_Relative
-                                                     t1,
-                                                     struct
-                                                     GNUNET_TIME_Relative t2);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
+                          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
@@ -211,13 +282,12 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
  * @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);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future);
 
 
 /**
- * Calculate the estimate time of arrival/completion 
+ * Calculate the estimate time of arrival/completion
  * for an operation.
  *
  * @param start when did the operation start?
@@ -226,9 +296,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining (struct
  * @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);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start, uint64_t finished,
+                           uint64_t total);
 
 
 /**
@@ -240,23 +310,20 @@ struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolu
  * @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
-                                                                 GNUNET_TIME_Absolute
-                                                                 start,
-                                                                 struct
-                                                                 GNUNET_TIME_Absolute
-                                                                 end);
+struct GNUNET_TIME_Relative
+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".
  *
- * @param hence some absolute time, typically in the past
+ * @param whence 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
-                                                               GNUNET_TIME_Absolute
-                                                               hence);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence);
 
 
 /**
@@ -267,12 +334,23 @@ struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration (struct
  * @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_Absolute
-                                                      start,
-                                                      struct
-                                                      GNUNET_TIME_Relative
-                                                      duration);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
+                          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.
@@ -281,11 +359,22 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add (struct
  * @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
-                                                           GNUNET_TIME_Relative
-                                                           rel,
-                                                           unsigned int
-                                                           factor);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
+                               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.
@@ -294,22 +383,32 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply (struct
  * @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 a1,
-                                                      struct
-                                                      GNUNET_TIME_Relative
-                                                      a2);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
+                          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
-                                                          a);
+struct GNUNET_TIME_RelativeNBO
+GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a);
+
 
 /**
  * Convert relative time from network byte order.
@@ -317,9 +416,9 @@ struct GNUNET_TIME_RelativeNBO GNUNET_TIME_relative_hton (struct
  * @param a time to convert
  * @return converted time value
  */
-struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh (struct
-                                                       GNUNET_TIME_RelativeNBO
-                                                       a);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a);
+
 
 /**
  * Convert relative time to network byte order.
@@ -327,9 +426,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh (struct
  * @param a time to convert
  * @return converted time value
  */
-struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton (struct
-                                                          GNUNET_TIME_Absolute
-                                                          a);
+struct GNUNET_TIME_AbsoluteNBO
+GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a);
+
 
 /**
  * Convert relative time from network byte order.
@@ -337,9 +436,30 @@ struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton (struct
  * @param a time to convert
  * @return converted time value
  */
-struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh (struct
-                                                       GNUNET_TIME_AbsoluteNBO
-                                                       a);
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a);
+
+
+/**
+ * Convert a relative time to a string.
+ * NOT reentrant!  FIXME: duplicate with GNUNET_STRINGS_relative_time_to_string!
+ *
+ * @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.
+ *
+ * @param offset the offset to skew the locale time by
+ */
+void
+GNUNET_TIME_set_offset (long long offset);
+
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {