5 This file is part of catta.
7 catta is free software; you can redistribute it and/or modify it
8 under the terms of the GNU Lesser General Public License as
9 published by the Free Software Foundation; either version 2.1 of the
10 License, or (at your option) any later version.
12 catta is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
15 Public License for more details.
17 You should have received a copy of the GNU Lesser General Public
18 License along with catta; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23 /** \file timeval.h Functions to facilitate timeval handling */
30 #include <catta/cdecl.h>
34 /** A numeric data type for storing microsecond values. (signed 64bit integer) */
35 typedef int64_t CattaUsec;
37 /** Compare two timeval structures and return a negative value when a < b, 0 when a == b and a positive value otherwise */
38 int catta_timeval_compare(const struct timeval *a, const struct timeval *b);
40 /** Calculate the difference between two timeval structures as microsecond value */
41 CattaUsec catta_timeval_diff(const struct timeval *a, const struct timeval *b);
43 /** Add a number of microseconds to the specified timeval structure and return it. *a is modified. */
44 struct timeval* catta_timeval_add(struct timeval *a, CattaUsec usec);
46 /** Return the difference between the current time and *a. Positive if *a was earlier */
47 CattaUsec catta_age(const struct timeval *a);
49 /** Fill *tv with the current time plus "ms" milliseconds plus an
50 * extra jitter of "j" milliseconds. Pass 0 for j if you don't want
52 struct timeval *catta_elapse_time(struct timeval *tv, unsigned ms, unsigned j);