Fix test_time on Mac OS X (and other platforms without inotify)
[asterisk/asterisk.git] / include / asterisk / localtime.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Tilghman Lesher <tlesher@vcch.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  * \brief Custom localtime functions for multiple timezones
22  */
23
24 #ifndef _ASTERISK_LOCALTIME_H
25 #define _ASTERISK_LOCALTIME_H
26
27 struct ast_tm {
28         int tm_sec;             /*!< Seconds. [0-60] (1 leap second) */
29         int tm_min;             /*!< Minutes. [0-59] */
30         int tm_hour;            /*!< Hours.   [0-23] */
31         int tm_mday;            /*!< Day.     [1-31] */
32         int tm_mon;             /*!< Month.   [0-11] */
33         int tm_year;            /*!< Year - 1900.  */
34         int tm_wday;            /*!< Day of week. [0-6] */
35         int tm_yday;            /*!< Days in year.[0-365]       */
36         int tm_isdst;           /*!< DST.               [-1/0/1]*/
37         long int tm_gmtoff;     /*!< Seconds east of UTC.  */
38         char *tm_zone;          /*!< Timezone abbreviation.  */
39         /* NOTE: do NOT reorder this final item.  The order needs to remain compatible with struct tm */
40         int tm_usec;        /*!< microseconds */
41 };
42
43 /*!\brief Timezone-independent version of localtime_r(3).
44  * \param timep Current time, including microseconds
45  * \param p_tm Pointer to memory where the broken-out time will be stored
46  * \param zone Text string of a standard system zoneinfo file.  If NULL, the system localtime will be used.
47  * \retval p_tm is returned for convenience
48  */
49 struct ast_tm *ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone);
50
51 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);
52
53 /*!\brief Timezone-independent version of mktime(3).
54  * \param tmp Current broken-out time, including microseconds
55  * \param zone Text string of a standard system zoneinfo file.  If NULL, the system localtime will be used.
56  * \retval A structure containing both seconds and fractional thereof since January 1st, 1970 UTC
57  */
58 struct timeval ast_mktime(struct ast_tm * const tmp, const char *zone);
59
60 /*!\brief Special version of strftime(3) that handles fractions of a second.
61  * Takes the same arguments as strftime(3), with the addition of %q, which
62  * specifies microseconds.
63  * \param buf Address in memory where the resulting string will be stored.
64  * \param len Size of the chunk of memory buf.
65  * \param format A string specifying the format of time to be placed into buf.
66  * \param tm Pointer to the broken out time to be used for the format.
67  * \retval An integer value specifying the number of bytes placed into buf or -1 on error.
68  */
69 int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm);
70
71 /*!\brief Special version of strptime(3) which places the answer in the common
72  * structure ast_tm.  Also, unlike strptime(3), ast_strptime() initializes its
73  * memory prior to use.
74  * \param s A string specifying some portion of a date and time.
75  * \param format The format in which the string, s, is expected.
76  * \param tm The broken-out time structure into which the parsed data is expected.
77  * \retval A pointer to the first character within s not used to parse the date and time.
78  */
79 char *ast_strptime(const char *s, const char *format, struct ast_tm *tm);
80
81 /*!\brief Wakeup localtime monitor thread
82  * For use in testing.  Normally, the failsafe monitor thread waits 60 seconds
83  * between checks to verify whether a timezone file has changed.  This routine
84  * forces the monitor thread to wakeup immediately and check the timezone files.
85  */
86 void ast_localtime_wakeup_monitor(void);
87
88 #endif /* _ASTERISK_LOCALTIME_H */