108 lines
4.7 KiB
C
108 lines
4.7 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2010, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.com>
|
|
* Tilghman Lesher <tlesher AT digium DOT com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
* \brief Custom localtime functions for multiple timezones
|
|
*/
|
|
|
|
#ifndef _ASTERISK_LOCALTIME_H
|
|
#define _ASTERISK_LOCALTIME_H
|
|
|
|
#ifdef HAVE_LOCALE_T_IN_LOCALE_H
|
|
#include <locale.h>
|
|
#elif defined(HAVE_LOCALE_T_IN_XLOCALE_H)
|
|
#include <xlocale.h>
|
|
#else
|
|
typedef void * locale_t;
|
|
#endif
|
|
|
|
struct ast_tm {
|
|
int tm_sec; /*!< Seconds. [0-60] (1 leap second) */
|
|
int tm_min; /*!< Minutes. [0-59] */
|
|
int tm_hour; /*!< Hours. [0-23] */
|
|
int tm_mday; /*!< Day. [1-31] */
|
|
int tm_mon; /*!< Month. [0-11] */
|
|
int tm_year; /*!< Year - 1900. */
|
|
int tm_wday; /*!< Day of week. [0-6] */
|
|
int tm_yday; /*!< Days in year.[0-365] */
|
|
int tm_isdst; /*!< DST. [-1/0/1]*/
|
|
long int tm_gmtoff; /*!< Seconds east of UTC. */
|
|
char *tm_zone; /*!< Timezone abbreviation. */
|
|
/* NOTE: do NOT reorder this final item. The order needs to remain compatible with struct tm */
|
|
int tm_usec; /*!< microseconds */
|
|
};
|
|
|
|
/*!\brief Timezone-independent version of localtime_r(3).
|
|
* \param timep Current time, including microseconds
|
|
* \param p_tm Pointer to memory where the broken-out time will be stored
|
|
* \param zone Text string of a standard system zoneinfo file. If NULL, the system localtime will be used.
|
|
* \retval p_tm is returned for convenience
|
|
*/
|
|
struct ast_tm *ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone);
|
|
|
|
void ast_get_dst_info(const time_t * const timep, int *dst_enabled, time_t *dst_start, time_t *dst_end, int *gmt_off, const char * const zone);
|
|
|
|
/*!\brief Timezone-independent version of mktime(3).
|
|
* \param tmp Current broken-out time, including microseconds
|
|
* \param zone Text string of a standard system zoneinfo file. If NULL, the system localtime will be used.
|
|
* \retval A structure containing both seconds and fractional thereof since January 1st, 1970 UTC
|
|
*/
|
|
struct timeval ast_mktime(struct ast_tm * const tmp, const char *zone);
|
|
|
|
/*!\brief Set the thread-local representation of the current locale. */
|
|
const char *ast_setlocale(const char *locale);
|
|
|
|
/*!\brief Special version of strftime(3) that handles fractions of a second.
|
|
* Takes the same arguments as strftime(3), with the addition of %q, which
|
|
* specifies microseconds.
|
|
* \param buf Address in memory where the resulting string will be stored.
|
|
* \param len Size of the chunk of memory buf.
|
|
* \param format A string specifying the format of time to be placed into buf.
|
|
* \param tm Pointer to the broken out time to be used for the format.
|
|
* \retval An integer value specifying the number of bytes placed into buf or -1 on error.
|
|
*/
|
|
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm);
|
|
int ast_strftime_locale(char *buf, size_t len, const char *format, const struct ast_tm *tm, const char *locale);
|
|
|
|
/*!\brief Special version of strptime(3) which places the answer in the common
|
|
* structure ast_tm. Also, unlike strptime(3), ast_strptime() initializes its
|
|
* memory prior to use.
|
|
* \param s A string specifying some portion of a date and time.
|
|
* \param format The format in which the string, s, is expected.
|
|
* \param tm The broken-out time structure into which the parsed data is expected.
|
|
* \retval A pointer to the first character within s not used to parse the date and time.
|
|
*/
|
|
char *ast_strptime(const char *s, const char *format, struct ast_tm *tm);
|
|
char *ast_strptime_locale(const char *s, const char *format, struct ast_tm *tm, const char *locale);
|
|
|
|
/*!\brief Wakeup localtime monitor thread
|
|
* For use in testing. Normally, the failsafe monitor thread waits 60 seconds
|
|
* between checks to verify whether a timezone file has changed. This routine
|
|
* forces the monitor thread to wakeup immediately and check the timezone files.
|
|
*/
|
|
struct ast_test;
|
|
void ast_localtime_wakeup_monitor(struct ast_test *info);
|
|
|
|
/*! \brief ast_strftime for ISO8601 formatting timestamps. */
|
|
#define AST_ISO8601_FORMAT "%FT%T.%q%z"
|
|
/*! \brief Max length of an null terminated, millisecond resolution, ISO8601 timestamp string. */
|
|
#define AST_ISO8601_LEN 29
|
|
|
|
#endif /* _ASTERISK_LOCALTIME_H */
|