mdw@git.distorted.org.uk Git - become/blob - src/daemon.h

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