git.meshlink.io Git - catta/blob - avahi-common/timeval.h

   1 #ifndef footimevalhfoo
   2 #define footimevalhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of avahi.
   8
   9   avahi is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, or (at your option) any later version.
  13
  14   avahi is distributed in the hope that it will be useful, but WITHOUT
  15   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  16   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  17   Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License along with avahi; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 /** \file timeval.h Functions to facilitate timeval handling */
  26
  27 #include <inttypes.h>
  28 #include <sys/time.h>
  29
  30 #include <avahi-common/cdecl.h>
  31
  32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  33 AVAHI_C_DECL_BEGIN
  34 #endif
  35
  36 /** A numeric data type for storing microsecond values. (signed 64bit integer) */
  37 typedef int64_t AvahiUsec;
  38
  39 /** Compare two timeval structures and return a ngeative value when a < b, 0 when a == b and a positive value otherwise */
  40 int avahi_timeval_compare(const struct timeval *a, const struct timeval *b);
  41
  42 /** Calculate the difference between to timeval structures as microsecond value */
  43 AvahiUsec avahi_timeval_diff(const struct timeval *a, const struct timeval *b);
  44
  45 /** Add a number of microseconds to the specified timeval structure and return it. *a is modified. */
  46 struct timeval* avahi_timeval_add(struct timeval *a, AvahiUsec usec);
  47
  48 /** Return the difference between the current time and *a. Positive if *a was earlier */
  49 AvahiUsec avahi_age(const struct timeval *a);
  50
  51 /** Fill *tv with the current time plus "ms" milliseconds plus an
  52  * extra jitter of "j" milliseconds. Pass 0 for j if you don't want
  53  * the jitter */
  54 struct timeval *avahi_elapse_time(struct timeval *tv, unsigned ms, unsigned j);
  55
  56 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  57 AVAHI_C_DECL_END
  58 #endif
  59
  60 #endif