Clock Handling

API for internal clock assess. More...

Collaboration diagram for Clock Handling:

Macros
#define	COAP_TICKS_PER_SECOND   ((coap_tick_t)(1000U))
	Use ms resolution on POSIX systems.
#define	COAP_MAX_DELAY_TICKS   (24 * 60 * 60 * COAP_TICKS_PER_SECOND)

Typedefs
typedef uint64_t	coap_tick_t
	This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
typedef time_t	coap_time_t
	CoAP time in seconds since epoch.
typedef int64_t	coap_tick_diff_t
	This data type is used to represent the difference between two clock_tick_t values.

Functions
void	coap_clock_init (void)
	Initializes the internal clock.
void	coap_ticks (coap_tick_t *t)
	Sets t to the internal time with COAP_TICKS_PER_SECOND resolution.
coap_time_t	coap_ticks_to_rt (coap_tick_t t)
	Helper function that converts coap ticks to wallclock time.
uint64_t	coap_ticks_to_rt_us (coap_tick_t t)
	Helper function that converts coap ticks to POSIX wallclock time in us.
coap_tick_t	coap_ticks_from_rt_us (uint64_t t)
	Helper function that converts POSIX wallclock time in us to coap ticks.
COAP_STATIC_INLINE int	coap_time_lt (coap_tick_t a, coap_tick_t b)
	Returns 1 if and only if a is less than b where less is defined on a signed data type.
COAP_STATIC_INLINE int	coap_time_le (coap_tick_t a, coap_tick_t b)
	Returns 1 if and only if a is less than or equal b where less is defined on a signed data type.

Detailed Description

API for internal clock assess.

Macro Definition Documentation

COAP_MAX_DELAY_TICKS

#define COAP_MAX_DELAY_TICKS   (24 * 60 * 60 * COAP_TICKS_PER_SECOND)

Definition at line 230 of file coap_time.h.

COAP_TICKS_PER_SECOND

#define COAP_TICKS_PER_SECOND   ((coap_tick_t)(1000U))

Use ms resolution on POSIX systems.

Definition at line 166 of file coap_time.h.

Typedef Documentation

coap_tick_diff_t

typedef int64_t coap_tick_diff_t

This data type is used to represent the difference between two clock_tick_t values.

This data type must have the same size in memory as coap_tick_t to allow wrapping.

Definition at line 163 of file coap_time.h.

coap_tick_t

typedef uint64_t coap_tick_t

This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.

Definition at line 151 of file coap_time.h.

coap_time_t

typedef time_t coap_time_t

CoAP time in seconds since epoch.

Definition at line 156 of file coap_time.h.

Function Documentation

coap_clock_init()

void coap_clock_init

(

void

)

Initializes the internal clock.

Definition at line 68 of file coap_time.c.

Here is the caller graph for this function:

coap_ticks()

void coap_ticks

(

coap_tick_t *

t

)

Sets t to the internal time with COAP_TICKS_PER_SECOND resolution.

Sets t to the internal time with COAP_TICKS_PER_SECOND resolution.

The counter counts COAP_TICKS_PER_SECOND ticks every second.

Definition at line 90 of file coap_time.c.

Here is the caller graph for this function:

coap_ticks_from_rt_us()

coap_tick_t coap_ticks_from_rt_us

(

uint64_t

t

)

Helper function that converts POSIX wallclock time in us to coap ticks.

Parameters

t	POSIX time is us

Returns

coap ticks

Definition at line 133 of file coap_time.c.

coap_ticks_to_rt()

coap_time_t coap_ticks_to_rt

(

coap_tick_t

t

)

Helper function that converts coap ticks to wallclock time.

On POSIX, this function returns the number of seconds since the epoch. On other systems, it may be the calculated number of seconds since last reboot or so.

Parameters

t	Internal system ticks.

Returns

The number of seconds that has passed since a specific reference point (seconds since epoch on POSIX).

Definition at line 123 of file coap_time.c.

Here is the caller graph for this function:

coap_ticks_to_rt_us()

uint64_t coap_ticks_to_rt_us

(

coap_tick_t

t

)

Helper function that converts coap ticks to POSIX wallclock time in us.

Parameters

t	Internal system ticks.

Returns

The number of seconds that has passed since a specific reference point (seconds since epoch on POSIX).

Definition at line 128 of file coap_time.c.

Here is the caller graph for this function:

coap_time_le()

COAP_STATIC_INLINE int coap_time_le	(	coap_tick_t	a,
		coap_tick_t	b
	)

Returns 1 if and only if a is less than or equal b where less is defined on a signed data type.

Definition at line 225 of file coap_time.h.

Here is the call graph for this function:

coap_time_lt()

COAP_STATIC_INLINE int coap_time_lt	(	coap_tick_t	a,
		coap_tick_t	b
	)

Returns 1 if and only if a is less than b where less is defined on a signed data type.

Definition at line 216 of file coap_time.h.

Here is the caller graph for this function: