X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_time_lib.h;h=224edc03e94920568786aaabd587a778020bfdd0;hb=7eb7bd8666aeb2e855cd22b1ea7f44b87bb60400;hp=b4b58f40cf7c95636cc75b393c4074f3b1119bfd;hpb=f27338992f0a5915ee974faea05f764c2df6f584;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h index b4b58f40c..224edc03e 100644 --- a/src/include/gnunet_time_lib.h +++ b/src/include/gnunet_time_lib.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - Copyright (C) 2001-2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2001-2013 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -19,10 +19,13 @@ */ /** - * @file include/gnunet_time_lib.h - * @brief functions related to time * @author Christian Grothoff - * @defgroup time Time and time calculations + * + * @file + * Functions related to time + * + * @defgroup time Time library + * Time and time calculations. * @{ */ @@ -255,6 +258,30 @@ struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel); +/** + * Round a time value so that it is suitable for transmission + * via JSON encodings. + * + * @param at time to round + * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if + * it was just now rounded + */ +int +GNUNET_TIME_round_abs (struct GNUNET_TIME_Absolute *at); + + +/** + * Round a time value so that it is suitable for transmission + * via JSON encodings. + * + * @param rt time to round + * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if + * it was just now rounded + */ +int +GNUNET_TIME_round_rel (struct GNUNET_TIME_Relative *rt); + + /** * Return the minimum of two relative time values. * @@ -349,7 +376,7 @@ GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start, * difference of the current time and the given start time "hence". * * @param whence some absolute time, typically in the past - * @return aborts if hence==FOREVER, 0 if hence > now, otherwise now-hence. + * @return 0 if hence > now, otherwise now-hence. */ struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence); @@ -390,7 +417,19 @@ GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start, */ struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel, - unsigned int factor); + unsigned long long factor); + + +/** + * Saturating 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_saturating_multiply (struct GNUNET_TIME_Relative rel, + unsigned long long factor); /** @@ -402,7 +441,7 @@ GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel, */ struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel, - unsigned int factor); + unsigned long long factor); /** @@ -521,9 +560,9 @@ GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at); } #endif -/** @} */ /* end of group time */ - - /* ifndef GNUNET_TIME_LIB_H */ #endif + +/** @} */ /* end of group time */ + /* end of gnunet_time_lib.h */