mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-05 17:32:54 +03:00
Carsten Schoenert
0e59edc231
Resume the cleaning of the public header files, no functional changes. Reformatting the infos in the head of the header files, restructure header inclusion check to be more generic. Reorder some include directives in a alphabetical order. Remove including instructions for C++ stuff, it's already done in the coap.h header, and the user only has to include this header file. Dropping the prefixing of the include guarding of uthash.h because it would cause trouble with the macro handling in TinyDLS. Thanks Olaf for reminding this!
143 lines
3.1 KiB
C
143 lines
3.1 KiB
C
/*
|
|
* coap_time.h -- Clock Handling
|
|
*
|
|
* Copyright (C) 2010-2013 Olaf Bergmann <bergmann@tzi.org>
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
/**
|
|
* @file coap_time.h
|
|
* @brief Clock Handling
|
|
*/
|
|
|
|
#ifndef _COAP_TIME_H_
|
|
#define _COAP_TIME_H_
|
|
|
|
/**
|
|
* @defgroup clock Clock Handling
|
|
* Default implementation of internal clock.
|
|
* @{
|
|
*/
|
|
|
|
#ifdef WITH_LWIP
|
|
|
|
#include <stdint.h>
|
|
#include <lwip/sys.h>
|
|
|
|
/* lwIP provides ms in sys_now */
|
|
#define COAP_TICKS_PER_SECOND 1000
|
|
|
|
typedef uint32_t coap_tick_t;
|
|
typedef uint32_t coap_time_t;
|
|
typedef int32_t coap_tick_diff_t;
|
|
|
|
static inline void coap_ticks_impl(coap_tick_t *t) {
|
|
*t = sys_now();
|
|
}
|
|
|
|
static inline void coap_clock_init_impl(void) {
|
|
}
|
|
|
|
#define coap_clock_init coap_clock_init_impl
|
|
#define coap_ticks coap_ticks_impl
|
|
|
|
static inline coap_time_t coap_ticks_to_rt(coap_tick_t t) {
|
|
return t / COAP_TICKS_PER_SECOND;
|
|
}
|
|
#endif
|
|
|
|
#ifdef WITH_CONTIKI
|
|
#include "clock.h"
|
|
|
|
typedef clock_time_t coap_tick_t;
|
|
typedef clock_time_t coap_time_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.
|
|
*/
|
|
typedef int coap_tick_diff_t;
|
|
|
|
#define COAP_TICKS_PER_SECOND CLOCK_SECOND
|
|
|
|
static inline void coap_clock_init(void) {
|
|
clock_init();
|
|
}
|
|
|
|
static inline void coap_ticks(coap_tick_t *t) {
|
|
*t = clock_time();
|
|
}
|
|
|
|
static inline coap_time_t coap_ticks_to_rt(coap_tick_t t) {
|
|
return t / COAP_TICKS_PER_SECOND;
|
|
}
|
|
#endif /* WITH_CONTIKI */
|
|
|
|
#ifdef WITH_POSIX
|
|
/**
|
|
* This data type represents internal timer ticks with COAP_TICKS_PER_SECOND
|
|
* resolution.
|
|
*/
|
|
typedef unsigned long coap_tick_t;
|
|
|
|
/**
|
|
* CoAP time in seconds since epoch.
|
|
*/
|
|
typedef time_t coap_time_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.
|
|
*/
|
|
typedef long coap_tick_diff_t;
|
|
|
|
/** Use ms resolution on POSIX systems */
|
|
#define COAP_TICKS_PER_SECOND 1000
|
|
|
|
/**
|
|
* Initializes the internal clock.
|
|
*/
|
|
void coap_clock_init(void);
|
|
|
|
/**
|
|
* Sets @p t to the internal time with COAP_TICKS_PER_SECOND resolution.
|
|
*/
|
|
void coap_ticks(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.
|
|
*
|
|
* @param t Internal system ticks.
|
|
*
|
|
* @return The number of seconds that has passed since a specific reference
|
|
* point (seconds since epoch on POSIX).
|
|
*/
|
|
coap_time_t coap_ticks_to_rt(coap_tick_t t);
|
|
#endif /* WITH_POSIX */
|
|
|
|
/**
|
|
* Returns @c 1 if and only if @p a is less than @p b where less is defined on a
|
|
* signed data type.
|
|
*/
|
|
static inline int coap_time_lt(coap_tick_t a, coap_tick_t b) {
|
|
return ((coap_tick_diff_t)(a - b)) < 0;
|
|
}
|
|
|
|
/**
|
|
* Returns @c 1 if and only if @p a is less than or equal @p b where less is
|
|
* defined on a signed data type.
|
|
*/
|
|
static inline int coap_time_le(coap_tick_t a, coap_tick_t b) {
|
|
return a == b || coap_time_lt(a,b);
|
|
}
|
|
|
|
/** @} */
|
|
|
|
#endif /* _COAP_TIME_H_ */
|