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