include/yaz/daemon.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: daemon.h,v 1.3 2008-02-21 10:44:43 adam Exp $ */
  28
  29 /**
  30  * \file daemon.h
  31  * \brief Unix daemon management
  32  */
  33
  34 #ifndef YAZ_DAEMON_H
  35 #define YAZ_DAEMON_H
  36
  37 #include <stdio.h>
  38 #include <yaz/yconfig.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 #define YAZ_DAEMON_FORK 1
  43 #define YAZ_DAEMON_DEBUG 2
  44 #define YAZ_DAEMON_KEEPALIVE 4
  45
  46 /** \brief daemon utility.
  47     \param progname program name for logging purposes.
  48     \param flags flags which is a bit-wise combination of YAZ_DAEMON_..
  49     \param work working handler (which may be running in different process)
  50     \param data opaque data to be passed to work handler
  51     \param pidfile filename with Process-ID (NULL for no file)
  52     \param uid effective user ID for handler (NULL for no same as caller)
  53     \returns 0 for success, non-zero for failure.
  54
  55     This function puts calls work handler which is supposed to carry
  56     out a daemon service with a possible changed User ID and in a
  57     child process.
  58
  59     Flag YAZ_DAEMON_FORK: Puts the service in the background on Unix.
  60
  61     Flag YAZ_DAEMON_DEBUG: Puts the service in debug mode (no fork at all).
  62
  63     Flag YAZ_DAEMON_KEEPALIVE: Repeatedly calls work handler if it makes a
  64     "fatal" error.
  65 */
  66 YAZ_EXPORT
  67 int yaz_daemon(const char *progname,
  68                unsigned int flags,
  69                void (*work)(void *data), void *data,
  70                const char *pidfile, const char *uid);
  71
  72 YAZ_END_CDECL
  73
  74 #endif
  75 /*
  76  * Local variables:
  77  * c-basic-offset: 4
  78  * indent-tabs-mode: nil
  79  * End:
  80  * vim: shiftwidth=4 tabstop=8 expandtab
  81  */
  82