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

   1 /* -*-c-*-
   2  *
   3  * $Id: tx.h,v 1.3 1998/01/12 16:46:32 mdw Exp $
   4  *
   5  * Transfer for keys and other large integers
   6  *
   7  * (c) 1998 Mark Wooding
   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: tx.h,v $
  32  * Revision 1.3  1998/01/12 16:46:32  mdw
  33  * Fix copyright date.
  34  *
  35  * Revision 1.2  1997/08/04 10:24:26  mdw
  36  * Sources placed under CVS control.
  37  *
  38  * Revision 1.1  1997/07/21  13:47:43  mdw
  39  * Initial revision
  40  *
  41  */
  42
  43 #ifndef TX_H
  44 #define TX_H
  45
  46 #ifdef __cplusplus
  47   extern "C" {
  48 #endif
  49
  50 /*----- Required headers --------------------------------------------------*/
  51
  52 #include <stddef.h>
  53
  54 /*----- Functions provided ------------------------------------------------*/
  55
  56 /* --- @tx_getBits@ --- *
  57  *
  58  * Arguments:   @unsigned char *k@ = pointer to key array to unpack into
  59  *              @size_t sz@ = number of bits to read (elements in array)
  60  *              @FILE *fp@ = stream to read from
  61  *
  62  * Returns:     ---
  63  *
  64  * Use:         Reads a number of bits into an array.  The least significant
  65  *              bits of the final word are cleared to zero.
  66  */
  67
  68 extern void tx_getBits(unsigned char */*k*/, size_t /*sz*/, FILE */*fp*/);
  69
  70 /* --- @tx_putBits@ --- *
  71  *
  72  * Arguments:   @unsigned char *k@ = pointer to key block
  73  *              @size_t sz@ = number of bits to write
  74  *              @FILE *fp@ = pointer to stream to write on
  75  *
  76  * Returns:     ---
  77  *
  78  * Use:         Complements @tx_getBits@ above.  Writes a number of bits
  79  *              to a file in an easy-to-read and transportable format (hex!)
  80  */
  81
  82 extern void tx_putBits(unsigned char */*k*/, size_t /*sz*/, FILE */*fp*/);
  83
  84 /*----- That's all, folks -------------------------------------------------*/
  85
  86 #ifdef __cplusplus
  87   }
  88 #endif
  89
  90 #endif