chiark - git - mdw - become/blob - src/noise.h

   1 /* -*-c-*-
   2  *
   3  * $Id: noise.h,v 1.2 1998/01/12 16:46:20 mdw Exp $
   4  *
   5  * Collection of environmental noise
   6  *
   7  * (c) 1998 EBI
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of `become'
  13  *
  14  * `Become' 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  * `Become' 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 `become'; 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: noise.h,v $
  32  * Revision 1.2  1998/01/12 16:46:20  mdw
  33  * Fix copyright date.
  34  *
  35  * Revision 1.1  1997/08/07 09:45:26  mdw
  36  * New source file added to acquire environmental noise and add it to the
  37  * randomness pool (see `rand.c').
  38  *
  39  */
  40
  41 #ifndef NOISE_H
  42 #define NOISE_H
  43
  44 #ifdef __cplusplus
  45   extern "C" {
  46 #endif
  47
  48 /*----- Functions provided ------------------------------------------------*/
  49
  50 /* --- @noise_acquire@ --- *
  51  *
  52  * Arguments:   ---
  53  *
  54  * Returns:     ---
  55  *
  56  * Use:         Attempts to acquire an amount of random noise from the
  57  *              environment.  A lot of it's not actually much good, but
  58  *              it's better than nothing.  There's probably a bit or two's
  59  *              worth in each item which gets added.
  60  */
  61
  62 extern void noise_acquire(void);
  63
  64 /*----- That's all, folks -------------------------------------------------*/
  65
  66 #ifdef __cplusplus
  67   }
  68 #endif
  69
  70 #endif
  71