-fix
[oweals/gnunet.git] / src / include / gnunet_time_lib.h
index 1a23f1ac2ae56d0c813cedfd86afdc76c76e1055..7090c33a1e4102c75ff849f7d3e9167a57c29ed6 100644 (file)
@@ -61,6 +61,7 @@ struct GNUNET_TIME_Relative
   uint64_t rel_value;
 };
 
+GNUNET_NETWORK_STRUCT_BEGIN
 
 /**
  * Time for relative time used by GNUnet, in milliseconds and in network byte order.
@@ -82,9 +83,9 @@ 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.
@@ -151,34 +152,40 @@ struct GNUNET_TIME_AbsoluteNBO
 /**
  * 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 "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 +194,8 @@ 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 +204,9 @@ 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);
 
 
 /**
@@ -212,11 +216,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
  * @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);
+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.
@@ -225,11 +227,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_max (struct
  * @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);
+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.
@@ -238,11 +238,9 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_min (struct
  * @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);
+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
@@ -251,13 +249,12 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_max (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?
@@ -266,9 +263,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);
 
 
 /**
@@ -280,23 +277,19 @@ 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);
 
 
 /**
@@ -307,12 +300,9 @@ 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);
 
 
 /**
@@ -323,12 +313,9 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add (struct
  * @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);
+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.
@@ -337,11 +324,9 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_subtract (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.
@@ -350,11 +335,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply (struct
  * @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);
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
+                             unsigned int factor);
 
 /**
  * Add relative times together.
@@ -363,11 +346,9 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide (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.
@@ -378,18 +359,17 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_add (struct
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
-                              struct GNUNET_TIME_Relative a2);
+                               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.
@@ -397,9 +377,8 @@ 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.
@@ -407,9 +386,8 @@ 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.
@@ -417,9 +395,27 @@ 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!
+ *
+ * @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 */
 {