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

   1 /* -*-c-*-
   2  *
   3  * $Id: daemon.h,v 1.5 2004/04/08 01:36:20 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 #ifndef DAEMON_H
  30 #define DAEMON_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Functions provided ------------------------------------------------*/
  37
  38 /* --- @daemon_usePort@ --- *
  39  *
  40  * Arguments:   @int port@ = port to use, please
  41  *
  42  * Returns:     ---
  43  *
  44  * Use:         Instructs the daemon to listen to the given port.
  45  */
  46
  47 extern void daemon_usePort(int /*port*/);
  48
  49 /* --- @daemon_readKey@ --- *
  50  *
  51  * Arguments:   @const char *kf@ = name of file containing key
  52  *
  53  * Returns:     ---
  54  *
  55  * Use:         Instructs the daemon to read the named key file.
  56  */
  57
  58 extern void daemon_readKey(const char */*kf*/);
  59
  60 /* --- @daemon_init@ --- *
  61  *
  62  * Arguments:   @const char *cf@ = pointer to name of configuration file
  63  *              @int port@ = port to listen to, or %$-1$% for default
  64  *
  65  * Returns:     Never.
  66  *
  67  * Use:         Starts `become' up in daemon mode.
  68  */
  69
  70 #define df_nofork 1u
  71
  72 extern void daemon_init(const char */*cf*/, int /*port*/, unsigned flags);
  73
  74 /*----- That's all, folks -------------------------------------------------*/
  75
  76 #ifdef __cplusplus
  77   }
  78 #endif
  79
  80 #endif