Fix up some doxygen issues.
[asterisk/asterisk.git] / include / asterisk / time.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  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Time-related functions and macros
21  */
22
23 #ifndef _ASTERISK_TIME_H
24 #define _ASTERISK_TIME_H
25
26 #ifdef HAVE_SYS_TIME_H
27 #include <sys/time.h>
28 #endif
29
30 #include "asterisk/inline_api.h"
31
32 /* We have to let the compiler learn what types to use for the elements of a
33    struct timeval since on linux, it's time_t and suseconds_t, but on *BSD,
34    they are just a long. */
35 extern struct timeval tv;
36 typedef typeof(tv.tv_sec) ast_time_t;
37 typedef typeof(tv.tv_usec) ast_suseconds_t;
38
39 /*!
40  * \brief Computes the difference (in seconds) between two \c struct \c timeval instances.
41  * \param end the end of the time period
42  * \param start the beginning of the time period
43  * \return the difference in seconds
44  */
45 AST_INLINE_API(
46 int ast_tvdiff_sec(struct timeval end, struct timeval start),
47 {
48         int result = end.tv_sec - start.tv_sec;
49         if (result > 0 && end.tv_usec < start.tv_usec)
50                 result--;
51         else if (result < 0 && end.tv_usec > start.tv_usec)
52                 result++;
53
54         return result;
55 }
56 )
57
58 /*!
59  * \brief Computes the difference (in microseconds) between two \c struct \c timeval instances.
60  * \param ast_tvdiff_sec 
61  * \arg end the end of the time period
62  * \arg start the beginning of the time period
63  * \return the difference in microseconds
64  */
65 AST_INLINE_API(
66 int64_t ast_tvdiff_us(struct timeval end, struct timeval start),
67 {
68         return (end.tv_sec - start.tv_sec) * (int64_t) 1000000 +
69                 end.tv_usec - start.tv_usec;
70 }
71 )
72
73 /*!
74  * \brief Computes the difference (in milliseconds) between two \c struct \c timeval instances.
75  * \param end end of the time period
76  * \param start beginning of the time period
77  * \return the difference in milliseconds
78  */
79 AST_INLINE_API(
80 int ast_tvdiff_ms(struct timeval end, struct timeval start),
81 {
82         /* the offset by 1,000,000 below is intentional...
83            it avoids differences in the way that division
84            is handled for positive and negative numbers, by ensuring
85            that the divisor is always positive
86         */
87         return  ((end.tv_sec - start.tv_sec) * 1000) +
88                 (((1000000 + end.tv_usec - start.tv_usec) / 1000) - 1000);
89 }
90 )
91
92 /*!
93  * \brief Returns true if the argument is 0,0
94  */
95 AST_INLINE_API(
96 int ast_tvzero(const struct timeval t),
97 {
98         return (t.tv_sec == 0 && t.tv_usec == 0);
99 }
100 )
101
102 /*!
103  * \brief Compres two \c struct \c timeval instances returning
104  * -1, 0, 1 if the first arg is smaller, equal or greater to the second.
105  */
106 AST_INLINE_API(
107 int ast_tvcmp(struct timeval _a, struct timeval _b),
108 {
109         if (_a.tv_sec < _b.tv_sec)
110                 return -1;
111         if (_a.tv_sec > _b.tv_sec)
112                 return 1;
113         /* now seconds are equal */
114         if (_a.tv_usec < _b.tv_usec)
115                 return -1;
116         if (_a.tv_usec > _b.tv_usec)
117                 return 1;
118         return 0;
119 }
120 )
121
122 /*!
123  * \brief Returns true if the two \c struct \c timeval arguments are equal.
124  */
125 AST_INLINE_API(
126 int ast_tveq(struct timeval _a, struct timeval _b),
127 {
128         return (_a.tv_sec == _b.tv_sec && _a.tv_usec == _b.tv_usec);
129 }
130 )
131
132 /*!
133  * \brief Returns current timeval. Meant to replace calls to gettimeofday().
134  */
135 AST_INLINE_API(
136 struct timeval ast_tvnow(void),
137 {
138         struct timeval t;
139         gettimeofday(&t, NULL);
140         return t;
141 }
142 )
143
144 /*!
145  * \brief Returns the sum of two timevals a + b
146  */
147 struct timeval ast_tvadd(struct timeval a, struct timeval b);
148
149 /*!
150  * \brief Returns the difference of two timevals a - b
151  */
152 struct timeval ast_tvsub(struct timeval a, struct timeval b);
153
154 /*!
155  * \brief Returns a timeval from sec, usec
156  */
157 AST_INLINE_API(
158 struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec),
159 {
160         struct timeval t;
161         t.tv_sec = sec;
162         t.tv_usec = usec;
163         return t;
164 }
165 )
166
167 /*!
168  * \brief Returns a timeval corresponding to the duration of n samples at rate r.
169  * Useful to convert samples to timevals, or even milliseconds to timevals
170  * in the form ast_samp2tv(milliseconds, 1000)
171  */
172 AST_INLINE_API(
173 struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate),
174 {
175         return ast_tv(_nsamp / _rate, (_nsamp % _rate) * (1000000 / _rate));
176 }
177 )
178
179 #endif /* _ASTERISK_TIME_H */