chiark - git - mdw - mLib/blob - tv.h

   1 /* -*-c-*-
   2  *
   3  * $Id: tv.h,v 1.4 1999/05/17 20:37:25 mdw Exp $
   4  *
   5  * Manipulation of timeval structures
   6  *
   7  * (c) 1998 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the mLib utilities library.
  13  *
  14  * mLib is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * mLib is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with mLib; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: tv.h,v $
  33  * Revision 1.4  1999/05/17 20:37:25  mdw
  34  * New function `tv_addl' to add a literal to a time value.
  35  *
  36  * Revision 1.3  1999/05/06 19:51:36  mdw
  37  * Reformatted the LGPL notice a little bit.
  38  *
  39  * Revision 1.2  1999/05/05 18:50:31  mdw
  40  * Change licensing conditions to LGPL.
  41  *
  42  * Revision 1.1  1998/11/25 23:30:01  mdw
  43  * New file.
  44  *
  45  */
  46
  47 #ifndef TV_H
  48 #define TV_H
  49
  50 #ifdef __cplusplus
  51   extern "C" {
  52 #endif
  53
  54 /*----- Header files ------------------------------------------------------*/
  55
  56 #include <sys/time.h>
  57
  58 /*----- Functions provided ------------------------------------------------*/
  59
  60 /* --- @tv_add@ --- *
  61  *
  62  * Arguments:   @struct timeval *dst@ = destination block
  63  *              @const struct timeval *a, *b@ = source blocks
  64  *
  65  * Returns:     ---
  66  *
  67  * Use:         Adds two timevals.
  68  */
  69
  70 extern void tv_add(struct timeval */*dst*/,
  71                    const struct timeval */*a*/,
  72                    const struct timeval */*b*/);
  73
  74 /* --- @tv_addl@ --- *
  75  *
  76  * Arguments:   @struct timeval *dst@ = destination block
  77  *              @const struct timeval *a@ = source blocks
  78  *              @time_t sec@, @unsigned long usec@ = time to add
  79  *
  80  * Returns:     ---
  81  *
  82  * Use:         Adds a literal time in seconds and microseconds.
  83  */
  84
  85 extern void tv_addl(struct timeval */*dst*/,
  86                     const struct timeval */*a*/,
  87                     time_t /*sec*/, unsigned long /*usec*/);
  88
  89 /* --- @tv_sub@ --- *
  90  *
  91  * Arguments:   @struct timeval *dst@ = destination block
  92  *              @const struct timeval *a, *b@ = source blocks
  93  *
  94  * Returns:     ---
  95  *
  96  * Use:         Subtracts two timevals.
  97  */
  98
  99 extern void tv_sub(struct timeval */*dst*/,
 100                    const struct timeval */*a*/,
 101                    const struct timeval */*b*/);
 102
 103 /* --- @tv_cmp@ --- *
 104  *
 105  * Arguments:   @const struct timeval *a, *b@ = source blocks
 106  *
 107  * Returns:     Less than, equal to, or greater than zero.
 108  *
 109  * Use:         Compares two timevals.
 110  */
 111
 112 extern int tv_cmp(const struct timeval */*a*/,
 113                   const struct timeval */*b*/);
 114
 115 /*----- That's all, folks -------------------------------------------------*/
 116
 117 #ifdef __cplusplus
 118   }
 119 #endif
 120
 121 #endif