cca5bdf42d577c45f525a83706db561b09eee2d8
[become] / src / daemon.h
1 /* -*-c-*-
2 *
3 * $Id: daemon.h,v 1.4 2003/10/12 10:00:06 mdw Exp $
4 *
5 * Running a `become' daemon
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: daemon.h,v $
32 * Revision 1.4 2003/10/12 10:00:06 mdw
33 * Fix for daemon mode. Oops.
34 *
35 * Revision 1.3 1998/01/12 16:46:01 mdw
36 * Fix copyright date.
37 *
38 * Revision 1.2 1997/08/04 10:24:21 mdw
39 * Sources placed under CVS control.
40 *
41 * Revision 1.1 1997/07/21 13:47:50 mdw
42 * Initial revision
43 *
44 */
45
46 #ifndef DAEMON_H
47 #define DAEMON_H
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 /*----- Functions provided ------------------------------------------------*/
54
55 /* --- @daemon_usePort@ --- *
56 *
57 * Arguments: @int port@ = port to use, please
58 *
59 * Returns: ---
60 *
61 * Use: Instructs the daemon to listen to the given port.
62 */
63
64 extern void daemon_usePort(int /*port*/);
65
66 /* --- @daemon_readKey@ --- *
67 *
68 * Arguments: @const char *kf@ = name of file containing key
69 *
70 * Returns: ---
71 *
72 * Use: Instructs the daemon to read the named key file.
73 */
74
75 extern void daemon_readKey(const char */*kf*/);
76
77 /* --- @daemon_init@ --- *
78 *
79 * Arguments: @const char *cf@ = pointer to name of configuration file
80 * @int port@ = port to listen to, or %$-1$% for default
81 *
82 * Returns: Never.
83 *
84 * Use: Starts `become' up in daemon mode.
85 */
86
87 #define df_nofork 1u
88
89 extern void daemon_init(const char */*cf*/, int /*port*/, unsigned flags);
90
91 /*----- That's all, folks -------------------------------------------------*/
92
93 #ifdef __cplusplus
94 }
95 #endif
96
97 #endif