Fix yaz URL
[yaz-moved-to-github.git] / include / yaz / daemon.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2010 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
28 /**
29  * \file daemon.h
30  * \brief Unix daemon management
31  */
32
33 #ifndef YAZ_DAEMON_H
34 #define YAZ_DAEMON_H
35
36 #include <stdio.h>
37 #include <yaz/yconfig.h>
38
39 YAZ_BEGIN_CDECL
40
41 #define YAZ_DAEMON_FORK 1
42 #define YAZ_DAEMON_DEBUG 2
43 #define YAZ_DAEMON_KEEPALIVE 4
44
45 /** \brief daemon utility.
46     \param progname program name for logging purposes.
47     \param flags flags which is a bit-wise combination of YAZ_DAEMON_..
48     \param work working handler (which may be running in different process)
49     \param data opaque data to be passed to work handler
50     \param pidfile filename with Process-ID (NULL for no file)
51     \param uid effective user ID for handler (NULL for no same as caller)
52     \returns 0 for success, non-zero for failure.
53
54     This function puts calls work handler which is supposed to carry
55     out a daemon service with a possible changed User ID and in a
56     child process.
57
58     Flag YAZ_DAEMON_FORK: Puts the service in the background on Unix.
59
60     Flag YAZ_DAEMON_DEBUG: Puts the service in debug mode (no fork at all).
61
62     Flag YAZ_DAEMON_KEEPALIVE: Repeatedly calls work handler if it makes a 
63     "fatal" error.
64 */
65 YAZ_EXPORT
66 int yaz_daemon(const char *progname,
67                unsigned int flags,
68                void (*work)(void *data), void *data,
69                const char *pidfile, const char *uid);
70
71 YAZ_END_CDECL
72
73 #endif
74 /*
75  * Local variables:
76  * c-basic-offset: 4
77  * c-file-style: "Stroustrup"
78  * indent-tabs-mode: nil
79  * End:
80  * vim: shiftwidth=4 tabstop=8 expandtab
81  */
82