Improved installation. Moved header files to include/yaz.
[yaz-moved-to-github.git] / include / yaz / statserv.h
1 /*
2  * Copyright (c) 1995-1999, Index Data.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation, in whole or in part, for any purpose, is hereby granted,
6  * provided that:
7  *
8  * 1. This copyright and permission notice appear in all copies of the
9  * software and its documentation. Notices of copyright or attribution
10  * which appear at the beginning of any file must remain unchanged.
11  *
12  * 2. The name of Index Data or the individual authors may not be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * $Log: statserv.h,v $
27  * Revision 1.1  1999-11-30 13:47:11  adam
28  * Improved installation. Moved header files to include/yaz.
29  *
30  * Revision 1.17  1999/07/06 12:17:15  adam
31  * Added option -1 that runs server once (for profiling purposes).
32  *
33  * Revision 1.16  1999/06/10 11:45:30  adam
34  * Added bend_start, bend_stop handlers and removed pre_init.
35  * Handlers bend_start/bend_stop are called when service/daemon is
36  * started/stopped.
37  *
38  * Revision 1.15  1999/04/16 14:45:55  adam
39  * Added interface for tcpd wrapper for access control.
40  *
41  * Revision 1.14  1999/02/02 13:57:32  adam
42  * Uses preprocessor define WIN32 instead of WINDOWS to build code
43  * for Microsoft WIN32.
44  *
45  * Revision 1.13  1998/02/10 10:28:56  adam
46  * Added app_name, service_dependencies, service_display_name and
47  * options_func. options_func allows us to specify a different function
48  * to interogate the command line arguments. The other members allow us
49  * to pass the full service details accross to the service manager (CW).
50  *
51  * Revision 1.??? 1997/12/18   Chas
52  * Added app_name, service_dependencies, service_display_name and 
53  * options_func. options_func allows us to specify a different function 
54  * to interogate the command line arguments. The other members allow us
55  * to pass the full service details accross to the service manager.
56  *
57  * Revision 1.12  1997/11/07 13:31:47  adam
58  * Added NT Service name part of statserv_options_block. Moved NT
59  * service utility to server library.
60  *
61  * Revision 1.11  1997/10/27 14:03:01  adam
62  * Added new member to statserver_options_block, pre_init, which
63  * specifies a callback to be invoked after command line parsing and
64  * before the server listens for the first time.
65  *
66  * Revision 1.10  1997/09/01 09:31:26  adam
67  * Removed definition statserv_remove to eventl.h. (A hack really).
68  *
69  * Revision 1.9  1997/09/01 08:49:53  adam
70  * New windows NT/95 port using MSV5.0. To export DLL functions the
71  * YAZ_EXPORT modifier was added. Defined in yconfig.h.
72  *
73  * Revision 1.8  1997/05/14 06:53:51  adam
74  * C++ support.
75  *
76  * Revision 1.7  1995/09/29 17:12:12  quinn
77  * Smallish
78  *
79  * Revision 1.6  1995/09/27  15:02:53  quinn
80  * Modified function heads & prototypes.
81  *
82  * Revision 1.5  1995/06/19  12:38:31  quinn
83  * Reorganized include-files. Added small features.
84  *
85  * Revision 1.4  1995/06/15  07:45:08  quinn
86  * Moving to v3.
87  *
88  * Revision 1.3  1995/05/16  08:50:38  quinn
89  * License, documentation, and memory fixes
90  *
91  *
92  */
93
94 #ifndef STATSERVER_H
95 #define STATSERVER_H
96
97 #include <yaz/yconfig.h>
98 #include <yaz/odr.h>
99 #include <yaz/oid.h>
100
101 #ifdef __cplusplus
102 extern "C" {
103 #endif
104     
105 typedef struct statserv_options_block
106 {
107     int dynamic;                  /* fork on incoming requests */
108     int one_shot;                 /* one session then exit(1) */
109     int loglevel;                 /* desired logging-level */
110     char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
111     char logfile[ODR_MAXNAME+1];  /* file for diagnostic output */
112     char default_listen[1024];    /* 0 == no default listen */
113     enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
114     int idle_timeout;             /* how many minutes to wait before closing */
115     int maxrecordsize;            /* maximum value for negotiation */
116     char configname[ODR_MAXNAME+1];  /* given to the backend in bend_init */
117     char setuid[ODR_MAXNAME+1];     /* setuid to this user after binding */
118     void (*bend_start)(struct statserv_options_block *p);
119     void (*bend_stop)(struct statserv_options_block *p);
120     int (*options_func)(int argc, char **argv);
121     int (*check_ip)(void *cd, const char *addr, int len, int type);
122     char daemon_name[128];
123     int inetd;                    /* Do we use the inet deamon or not */
124     
125 #ifdef WIN32
126     /* We only have these members for the windows version */
127     /* They seemed a bit large to have them there in general */
128     char service_name[128];         /* NT Service Name */
129     char app_name[128];             /* Application Name */
130     char service_dependencies[128]; /* The services we are dependent on */
131     char service_display_name[128]; /* The service display name */
132 #endif /* WIN32 */
133 } statserv_options_block;
134     
135 int statserv_main(int argc, char **argv);
136 int statserv_start(int argc, char **argv);
137 void statserv_closedown(void);
138 statserv_options_block *statserv_getcontrol(void);
139 void statserv_setcontrol(statserv_options_block *block);
140
141 int check_ip_tcpd(void *cd, const char *addr, int len, int type);
142
143 #ifdef __cplusplus
144 }
145 #endif
146
147 #endif