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

   1 /* -*-c-*-
   2  *
   3  * $Id: tv.h,v 1.1 1998/11/25 23:30:01 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 General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (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 General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with mLib; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: tv.h,v $
  32  * Revision 1.1  1998/11/25 23:30:01  mdw
  33  * New file.
  34  *
  35  */
  36
  37 #ifndef TV_H
  38 #define TV_H
  39
  40 #ifdef __cplusplus
  41   extern "C" {
  42 #endif
  43
  44 /*----- Header files ------------------------------------------------------*/
  45
  46 #include <sys/time.h>
  47
  48 /*----- Functions provided ------------------------------------------------*/
  49
  50 /* --- @tv_add@ --- *
  51  *
  52  * Arguments:   @struct timeval *dst@ = destination block
  53  *              @const struct timeval *a, *b@ = source blocks
  54  *
  55  * Returns:     ---
  56  *
  57  * Use:         Adds two timevals.
  58  */
  59
  60 extern void tv_add(struct timeval */*dst*/,
  61                    const struct timeval */*a*/,
  62                    const struct timeval */*b*/);
  63
  64 /* --- @tv_sub@ --- *
  65  *
  66  * Arguments:   @struct timeval *dst@ = destination block
  67  *              @const struct timeval *a, *b@ = source blocks
  68  *
  69  * Returns:     ---
  70  *
  71  * Use:         Subtracts two timevals.
  72  */
  73
  74 extern void tv_sub(struct timeval */*dst*/,
  75                    const struct timeval */*a*/,
  76                    const struct timeval */*b*/);
  77
  78 /* --- @tv_cmp@ --- *
  79  *
  80  * Arguments:   @const struct timeval *a, *b@ = source blocks
  81  *
  82  * Returns:     Less than, equal to, or greater than zero.
  83  *
  84  * Use:         Compares two timevals.
  85  */
  86
  87 extern int tv_cmp(const struct timeval */*a*/,
  88                   const struct timeval */*b*/);
  89
  90 /*----- That's all, folks -------------------------------------------------*/
  91
  92 #ifdef __cplusplus
  93   }
  94 #endif
  95
  96 #endif