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

   1 /* -*-c-*-
   2  *
   3  * $Id: tv.h,v 1.2 1999/05/05 18:50:31 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 Software
  26  * Foundation, 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.2  1999/05/05 18:50:31  mdw
  33  * Change licensing conditions to LGPL.
  34  *
  35  * Revision 1.1  1998/11/25 23:30:01  mdw
  36  * New file.
  37  *
  38  */
  39
  40 #ifndef TV_H
  41 #define TV_H
  42
  43 #ifdef __cplusplus
  44   extern "C" {
  45 #endif
  46
  47 /*----- Header files ------------------------------------------------------*/
  48
  49 #include <sys/time.h>
  50
  51 /*----- Functions provided ------------------------------------------------*/
  52
  53 /* --- @tv_add@ --- *
  54  *
  55  * Arguments:   @struct timeval *dst@ = destination block
  56  *              @const struct timeval *a, *b@ = source blocks
  57  *
  58  * Returns:     ---
  59  *
  60  * Use:         Adds two timevals.
  61  */
  62
  63 extern void tv_add(struct timeval */*dst*/,
  64                    const struct timeval */*a*/,
  65                    const struct timeval */*b*/);
  66
  67 /* --- @tv_sub@ --- *
  68  *
  69  * Arguments:   @struct timeval *dst@ = destination block
  70  *              @const struct timeval *a, *b@ = source blocks
  71  *
  72  * Returns:     ---
  73  *
  74  * Use:         Subtracts two timevals.
  75  */
  76
  77 extern void tv_sub(struct timeval */*dst*/,
  78                    const struct timeval */*a*/,
  79                    const struct timeval */*b*/);
  80
  81 /* --- @tv_cmp@ --- *
  82  *
  83  * Arguments:   @const struct timeval *a, *b@ = source blocks
  84  *
  85  * Returns:     Less than, equal to, or greater than zero.
  86  *
  87  * Use:         Compares two timevals.
  88  */
  89
  90 extern int tv_cmp(const struct timeval */*a*/,
  91                   const struct timeval */*b*/);
  92
  93 /*----- That's all, folks -------------------------------------------------*/
  94
  95 #ifdef __cplusplus
  96   }
  97 #endif
  98
  99 #endif