Timestamp functions relating to points in time (including the current time). More...

Collaboration diagram for timestamp:

Typedefs
typedef uint64_t	absolute_time_t
	An opaque 64 bit timestamp in microseconds.

Variables
const absolute_time_t	at_the_end_of_time
	The timestamp representing the end of time; this is actually not the maximum possible timestamp, but is set to 0x7fffffff_ffffffff microseconds to avoid sign overflows with time arithmetic. This is almost 300,000 years, so should be sufficient.

const absolute_time_t	nil_time
	The timestamp representing a null timestamp.

Detailed Description

Timestamp functions relating to points in time (including the current time).

These are functions for dealing with timestamps (i.e. instants in time) represented by the type absolute_time_t. This opaque type is provided to help prevent accidental mixing of timestamps and relative time values.

Typedef Documentation

◆ absolute_time_t

typedef uint64_t absolute_time_t

An opaque 64 bit timestamp in microseconds.

The type is used instead of a raw uint64_t to prevent accidentally passing relative times or times in the wrong time units where an absolute time is required.

note: As of SDK 2.0.0 this type defaults to being a uin64_t (i.e. no protection); it is enabled by setting PICO_OPAQUE_ABSOLUTE_TIME_T to 1

See also: to_us_since_boot(); update_us_since_boot()

Definition at line 43 of file types.h.

Variable Documentation

◆ at_the_end_of_time

const absolute_time_t at_the_end_of_time

extern

The timestamp representing the end of time; this is actually not the maximum possible timestamp, but is set to 0x7fffffff_ffffffff microseconds to avoid sign overflows with time arithmetic. This is almost 300,000 years, so should be sufficient.

◆ nil_time

const absolute_time_t nil_time