Provide a `--pidfile' option in `fw'.
[fwd] / fw.h
1 /* -*-c-*-
2 *
3 * $Id: fw.h,v 1.4 2004/04/08 01:36:25 mdw Exp $
4 *
5 * Main header file for port forwarder
6 *
7 * (c) 1999 Straylight/Edgeware
8 */
9
10 /*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of the `fw' port forwarder.
13 *
14 * `fw' 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 * `fw' 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 `fw'; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 */
28
29 #ifndef FW_H
30 #define FW_H
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 /*----- Header files ------------------------------------------------------*/
37
38 #include <time.h>
39 #include <fcntl.h>
40 #include <mLib/sel.h>
41
42 /*----- Global variables --------------------------------------------------*/
43
44 extern sel_state *sel;
45
46 /*----- Functions provided ------------------------------------------------*/
47
48 /* --- @fw_log@ --- *
49 *
50 * Arguments: @time_t t@ = when the connection occurred or (@-1@)
51 * @const char *fmt@ = format string to fill in
52 * @...@ = other arguments
53 *
54 * Returns: ---
55 *
56 * Use: Logs a connection.
57 */
58
59 extern void fw_log(time_t /*t*/, const char */*fmt*/, ...);
60
61 /* --- @fw_inc@, @fw_dec@ --- *
62 *
63 * Arguments: ---
64 *
65 * Returns: ---
66 *
67 * Use: Increments or decrements the active thing count. `fw' won't
68 * quit while there are active things.
69 */
70
71 extern void fw_inc(void);
72 extern void fw_dec(void);
73
74 /*----- That's all, folks -------------------------------------------------*/
75
76 #ifdef __cplusplus
77 }
78 #endif
79
80 #endif