Initial revision

[become] / src / daemon.h

/* -*-c-*-
 *
 * $Id: daemon.h,v 1.1 1997/07/21 13:47:50 mdw Exp $
 *
 * Running a `become' daemon
 *
 * (c) 1997 EBI
 */

/*----- Licencing notice --------------------------------------------------*
 *
 * This file is part of `become'
 *
 * `Become' is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * `Become' is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with `become'; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*----- Revision history --------------------------------------------------*
 *
 * $Log: daemon.h,v $
 * Revision 1.1  1997/07/21 13:47:50  mdw
 * Initial revision
 *
 */

#ifndef DAEMON_H
#define DAEMON_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Functions provided ------------------------------------------------*/

/* --- @daemon_usePort@ --- *
 *
 * Arguments:	@int port@ = port to use, please
 *
 * Returns:	---
 *
 * Use:		Instructs the daemon to listen to the given port.
 */

extern void daemon_usePort(int /*port*/);

/* --- @daemon_readKey@ --- *
 *
 * Arguments:	@const char *kf@ = name of file containing key
 *
 * Returns:	---
 *
 * Use:		Instructs the daemon to read the named key file.
 */

extern void daemon_readKey(const char */*kf*/);

/* --- @daemon_init@ --- *
 *
 * Arguments:	@const char *cf@ = pointer to name of configuration file
 *		@int port@ = port to listen to, or %$-1$% for default
 *
 * Returns:	Never.
 *
 * Use:		Starts `become' up in daemon mode.
 */

extern void daemon_init(const char */*cf*/, int /*port*/);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif