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

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