sys: timeutil: add module
Add a generic API to provide the inverse operation for gmtime and as a home for future generic time-related functions that are not in POSIX. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
This commit is contained in:
parent
3e8df8b369
commit
9d25b671bc
3 changed files with 103 additions and 0 deletions
41
include/sys/timeutil.h
Normal file
41
include/sys/timeutil.h
Normal file
|
@ -0,0 +1,41 @@
|
|||
/*
|
||||
* Copyright (c) 2019 Peter Bigot Consulting, LLC
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief Utilities supporting operation on time data structures.
|
||||
*
|
||||
* POSIX defines gmtime() to convert from time_t to struct tm, but all
|
||||
* inverse transformations are non-standard or require access to time
|
||||
* zone information. timeutil_timegm() implements the functionality
|
||||
* of the GNU extension timegm() function.
|
||||
*/
|
||||
|
||||
#ifndef ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_
|
||||
#define ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_
|
||||
|
||||
#include <time.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Convert broken-down time to a POSIX epoch offset in seconds.
|
||||
*
|
||||
* @param tm pointer to broken down time.
|
||||
*
|
||||
* @return the corresponding time in the POSIX epoch time scale.
|
||||
*
|
||||
* @see http://man7.org/linux/man-pages/man3/timegm.3.html
|
||||
*/
|
||||
time_t timeutil_timegm(struct tm *tm);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* ZEPHYR_INCLUDE_SYS_TIMEUTIL_H_ */
|
Loading…
Add table
Add a link
Reference in a new issue