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

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