gnunet_time_lib.h File Reference

Functions related to time. More...

#include "gnunet_common.h"

Include dependency graph for gnunet_time_lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_TIME_Absolute
	Time for absolute times used by GNUnet, in microseconds. More...
struct	GNUNET_TIME_Timestamp
	Time for timestamps used by GNUnet, in microseconds rounded to seconds. More...
struct	GNUNET_TIME_Relative
	Time for relative time used by GNUnet, in microseconds. More...
struct	GNUNET_TIME_RelativeNBO
	Time for relative time used by GNUnet, in microseconds and in network byte order. More...
struct	GNUNET_TIME_AbsoluteNBO
	Time for absolute time used by GNUnet, in microseconds and in network byte order. More...
struct	GNUNET_TIME_TimestampNBO
	Time for timestamps used by GNUnet, in seconds and in network byte order. More...

Macros
#define	GNUNET_TIME_UNIT_ZERO   ((struct GNUNET_TIME_Relative){0})
	Relative time zero.
#define	GNUNET_TIME_UNIT_ZERO_ABS   ((struct GNUNET_TIME_Absolute){0})
	Absolute time zero.
#define	GNUNET_TIME_UNIT_ZERO_TS   ((struct GNUNET_TIME_Timestamp){{0}})
	Timestamp of zero.
#define	GNUNET_TIME_UNIT_MICROSECONDS   GNUNET_TIME_relative_get_unit_ ()
	One microsecond, our basic time unit.
#define	GNUNET_TIME_UNIT_MILLISECONDS   GNUNET_TIME_relative_get_millisecond_ ()
	One millisecond.
#define	GNUNET_TIME_UNIT_SECONDS   GNUNET_TIME_relative_get_second_ ()
	One second.
#define	GNUNET_TIME_UNIT_MINUTES   GNUNET_TIME_relative_get_minute_ ()
	One minute.
#define	GNUNET_TIME_UNIT_HOURS   GNUNET_TIME_relative_get_hour_ ()
	One hour.
#define	GNUNET_TIME_UNIT_DAYS
	One day.
#define	GNUNET_TIME_UNIT_WEEKS
	One week.
#define	GNUNET_TIME_UNIT_MONTHS
	One month (30 days).
#define	GNUNET_TIME_UNIT_YEARS
	One year (365 days).
#define	GNUNET_TIME_UNIT_FOREVER_REL    ((struct GNUNET_TIME_Relative){UINT64_MAX})
	Constant used to specify "forever".
#define	GNUNET_TIME_UNIT_FOREVER_ABS    ((struct GNUNET_TIME_Absolute){UINT64_MAX})
	Constant used to specify "forever".
#define	GNUNET_TIME_UNIT_NEVER_ABS    ((struct GNUNET_TIME_Absolute){UINT64_MAX})
#define	GNUNET_TIME_UNIT_FOREVER_TS    ((struct GNUNET_TIME_Timestamp){{UINT64_MAX}})
	Constant used to specify "forever".
#define	GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD    GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
	Threshold after which exponential backoff should not increase (15 m).
#define	GNUNET_TIME_STD_BACKOFF(r)
	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.
#define	GNUNET_TIME_absolute_cmp(t1, op, t2)    ((void) (1 op 2), (t1).abs_value_us op (t2).abs_value_us)
	Compare two absolute times.
#define	GNUNET_TIME_timestamp_cmp(t1, op, t2)    GNUNET_TIME_absolute_cmp ((t1).abs_time,op,(t2).abs_time)
	Compare two timestamps.
#define	GNUNET_TIME_relative_cmp(t1, op, t2)    ((void) (1 op 2), (t1).rel_value_us op (t2).rel_value_us)
	Compare two relative times.

Enumerations
enum	GNUNET_TIME_RounderInterval {   GNUNET_TIME_RI_NONE = 0 , GNUNET_TIME_RI_SECOND , GNUNET_TIME_RI_MINUTE , GNUNET_TIME_RI_HOUR ,   GNUNET_TIME_RI_DAY , GNUNET_TIME_RI_WEEK , GNUNET_TIME_RI_MONTH , GNUNET_TIME_RI_QUARTER ,   GNUNET_TIME_RI_YEAR }
	Quantities by which we support round up absolute time values. More...

Functions
enum GNUNET_TIME_RounderInterval	GNUNET_TIME_relative_to_round_interval (struct GNUNET_TIME_Relative rel)
	Convert a relative time to the corresponding rounding interval.
enum GNUNET_GenericReturnValue	GNUNET_TIME_string_to_round_interval (const char *ri_str, enum GNUNET_TIME_RounderInterval *ri)
	Convert rounding interval given as a string to the enum value.
const char *	GNUNET_TIME_round_interval2s (enum GNUNET_TIME_RounderInterval ri)
	Convert rounding interval to string.
struct GNUNET_TIME_Absolute	GNUNET_TIME_round_up (struct GNUNET_TIME_Absolute at, enum GNUNET_TIME_RounderInterval ri)
	Round up the given at to the interval ri.
struct GNUNET_TIME_Absolute	GNUNET_TIME_round_down (struct GNUNET_TIME_Absolute at, enum GNUNET_TIME_RounderInterval ri)
	Round @at down to the start of the next interval ri.
const char *	GNUNET_TIME_timestamp2s (struct GNUNET_TIME_Timestamp ts)
	Convert ts to human-readable timestamp.
const char *	GNUNET_TIME_absolute2s (struct GNUNET_TIME_Absolute ts)
	Like asctime, except for GNUnet time.
const char *	GNUNET_TIME_relative2s (struct GNUNET_TIME_Relative delta, bool do_round)
	Give relative time in human-readable fancy format.
struct GNUNET_TIME_Relative	GNUNET_TIME_randomized_backoff (struct GNUNET_TIME_Relative rt, struct GNUNET_TIME_Relative threshold)
	Randomized exponential back-off, starting at 1 ms and going up by a factor of 2+r, where 0 <= r <= 0.5, up to a maximum of the given threshold.
struct GNUNET_TIME_Relative	GNUNET_TIME_randomize (struct GNUNET_TIME_Relative r)
	Return a random time value between 0.5*r and 1.5*r.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_zero_ (void)
	Return relative time of 0ms.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_get_zero_ (void)
	Return absolute time of 0ms.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_unit_ (void)
	Return relative time of 1 microsecond.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_millisecond_ (void)
	Return relative time of 1ms.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_second_ (void)
	Return relative time of 1s.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_minute_ (void)
	Return relative time of 1 minute.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_hour_ (void)
	Return relative time of 1 hour.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_get_forever_ (void)
	Return "forever".
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_get_forever_ (void)
	Return "forever".
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_get (void)
	Get the current time.
struct GNUNET_TIME_Absolute	GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
	Convert relative time to an absolute time in the future.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_relative_to_timestamp (struct GNUNET_TIME_Relative rel)
	Convert relative time to a timestamp in the future.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_absolute_to_timestamp (struct GNUNET_TIME_Absolute at)
	Round an absolute time to a timestamp.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_timestamp_get (void)
	Get timestamp representing the current time.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1, struct GNUNET_TIME_Relative t2)
	Return the minimum of two relative time values.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1, struct GNUNET_TIME_Relative t2)
	Return the maximum of two relative time values.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1, struct GNUNET_TIME_Absolute t2)
	Return the minimum of two absolute time values.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_max (struct GNUNET_TIME_Absolute t1, struct GNUNET_TIME_Absolute t2)
	Return the maximum of two absolute time values.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_round_down (struct GNUNET_TIME_Absolute at, struct GNUNET_TIME_Relative rt)
	Round down absolute time at to multiple of rt.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_timestamp_max (struct GNUNET_TIME_Timestamp t1, struct GNUNET_TIME_Timestamp t2)
	Return the maximum of two timestamps.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_timestamp_min (struct GNUNET_TIME_Timestamp t1, struct GNUNET_TIME_Timestamp t2)
	Return the minimum of two timestamps.
struct GNUNET_TIME_Relative	GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future)
	Given a timestamp in the future, how much time remains until then?
bool	GNUNET_TIME_absolute_approx_eq (struct GNUNET_TIME_Absolute a1, struct GNUNET_TIME_Absolute a2, struct GNUNET_TIME_Relative t)
	Test if a1 and a2 are equal within a margin of error of t.
struct GNUNET_TIME_Relative	GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start, uint64_t finished, uint64_t total)
	Calculate the estimate time of arrival/completion for an operation.
struct GNUNET_TIME_Relative	GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Absolute end)
	Compute the time difference between the given start and end times.
struct GNUNET_TIME_Relative	GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence)
	Get the duration of an operation as the difference of the current time and the given start time "hence".
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
	Add a given relative duration to the given start time.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
	Subtract a given relative duration from the given start time.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_multiply_double (struct GNUNET_TIME_Relative rel, double factor)
	Multiply relative time by a given factor.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel, unsigned long long factor)
	Multiply relative time by a given factor.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_saturating_multiply (struct GNUNET_TIME_Relative rel, unsigned long long factor)
	Saturating multiply relative time by a given factor.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel, unsigned long long factor)
	Divide relative time by a given factor.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1, struct GNUNET_TIME_Relative a2)
	Add relative times together.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1, struct GNUNET_TIME_Relative a2)
	Subtract relative timestamp from the other.
struct GNUNET_TIME_RelativeNBO	GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a)
	Convert relative time to network byte order.
struct GNUNET_TIME_Relative	GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a)
	Convert relative time from network byte order.
struct GNUNET_TIME_AbsoluteNBO	GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a)
	Convert absolute time to network byte order.
struct GNUNET_TIME_TimestampNBO	GNUNET_TIME_timestamp_hton (struct GNUNET_TIME_Timestamp t)
	Convert timestamp to network byte order.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_from_ms (uint64_t ms_after_epoch)
	Convert milliseconds after the UNIX epoch to absolute time.
bool	GNUNET_TIME_absolute_is_never (struct GNUNET_TIME_Absolute abs)
	Test if abs is never.
bool	GNUNET_TIME_absolute_is_past (struct GNUNET_TIME_Absolute abs)
	Test if abs is truly in the past (excluding now).
bool	GNUNET_TIME_absolute_is_zero (struct GNUNET_TIME_Absolute abs)
	Test if abs is truly zero.
bool	GNUNET_TIME_absolute_is_future (struct GNUNET_TIME_Absolute abs)
	Test if abs is truly in the future (excluding now).
bool	GNUNET_TIME_relative_is_forever (struct GNUNET_TIME_Relative rel)
	Test if rel is forever.
bool	GNUNET_TIME_relative_is_zero (struct GNUNET_TIME_Relative rel)
	Test if rel is zero.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_from_s (uint64_t s_after_epoch)
	Convert seconds after the UNIX epoch to absolute time.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_timestamp_from_s (uint64_t s_after_epoch)
	Convert seconds after the UNIX epoch to timestamp.
uint64_t	GNUNET_TIME_timestamp_to_s (struct GNUNET_TIME_Timestamp ts)
	Convert timestamp to number of seconds after the UNIX epoch.
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a)
	Convert absolute time from network byte order.
struct GNUNET_TIME_Timestamp	GNUNET_TIME_timestamp_ntoh (struct GNUNET_TIME_TimestampNBO tn)
	Convert timestamp from network byte order.
void	GNUNET_TIME_set_offset (long long offset)
	Set the timestamp offset for this instance.
long long	GNUNET_TIME_get_offset (void)
	Get the timestamp offset for this instance.
unsigned int	GNUNET_TIME_get_current_year (void)
	Return the current year (e.g.
struct GNUNET_TIME_Absolute	GNUNET_TIME_year_to_time (unsigned int year)
	Convert a year to an expiration time of January 1st of that year.
unsigned int	GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at)
	Convert an expiration time to the respective year (rounds)
struct GNUNET_TIME_Absolute	GNUNET_TIME_absolute_get_monotonic (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Obtain the current time and make sure it is monotonically increasing.

Detailed Description

Functions related to time.

Definition in file gnunet_time_lib.h.