2 * DEBUG: section 84 Helper process maintenance
3 * AUTHOR: Harvest Derived?
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
33 #ifndef SQUID_HELPER_H
34 #define SQUID_HELPER_H
38 #include "ip/IpAddress.h"
42 typedef struct _helper helper
;
44 typedef struct _helper_stateful statefulhelper
;
46 typedef struct _helper_server helper_server
;
48 typedef struct _helper_stateful_server helper_stateful_server
;
50 typedef struct _helper_flags helper_flags
;
52 typedef struct _helper_stateful_flags helper_stateful_flags
;
54 typedef void HLPSCB(void *, void *lastserver
, char *buf
);
61 int n_to_start
; ///< Configuration setting of how many helper children should be running
62 int n_running
; ///< Total helper children objects currently existing
63 int n_active
; ///< Count of helper children active (not shutting down)
66 unsigned int concurrency
;
67 time_t last_queue_warn
;
78 struct _helper_stateful
{
83 int n_to_start
; ///< Configuration setting of how many helper children should be running
84 int n_running
; ///< Total helper children objects currently existing
85 int n_active
; ///< Count of helper children active (not shutting down)
88 MemAllocator
*datapool
;
89 HLPSAVAIL
*IsAvailable
;
90 HLPSONEQ
*OnEmptyQueue
;
91 time_t last_queue_warn
;
102 struct _helper_server
{
114 struct timeval dispatch_time
;
116 struct timeval answer_time
;
120 helper_request
**requests
;
122 struct _helper_flags
{
123 unsigned int writing
:1;
124 unsigned int closing
:1;
125 unsigned int shutdown
:1;
130 unsigned int pending
;
136 class helper_stateful_request
;
138 struct _helper_stateful_server
{
145 /* MemBuf writebuf; */
150 struct timeval dispatch_time
;
152 struct timeval answer_time
;
155 statefulhelper
*parent
;
156 helper_stateful_request
*request
;
158 struct _helper_stateful_flags
{
160 unsigned int closing
:1;
161 unsigned int shutdown
:1;
162 unsigned int reserved
:1;
170 void *data
; /* State data used by the calling routines */
178 MEMPROXY_CLASS(helper_request
);
183 struct timeval dispatch_time
;
186 MEMPROXY_CLASS_INLINE(helper_request
);
188 class helper_stateful_request
192 MEMPROXY_CLASS(helper_stateful_request
);
195 int placeholder
; /* if 1, this is a dummy request waiting for a stateful helper to become available */
199 MEMPROXY_CLASS_INLINE(helper_stateful_request
);
202 SQUIDCEXTERN
void helperOpenServers(helper
* hlp
);
203 SQUIDCEXTERN
void helperStatefulOpenServers(statefulhelper
* hlp
);
204 SQUIDCEXTERN
void helperSubmit(helper
* hlp
, const char *buf
, HLPCB
* callback
, void *data
);
205 SQUIDCEXTERN
void helperStatefulSubmit(statefulhelper
* hlp
, const char *buf
, HLPSCB
* callback
, void *data
, helper_stateful_server
* lastserver
);
206 SQUIDCEXTERN
void helperStats(StoreEntry
* sentry
, helper
* hlp
, const char *label
= NULL
);
207 SQUIDCEXTERN
void helperStatefulStats(StoreEntry
* sentry
, statefulhelper
* hlp
, const char *label
= NULL
);
208 SQUIDCEXTERN
void helperShutdown(helper
* hlp
);
209 SQUIDCEXTERN
void helperStatefulShutdown(statefulhelper
* hlp
);
210 SQUIDCEXTERN helper
*helperCreate(const char *);
211 SQUIDCEXTERN statefulhelper
*helperStatefulCreate(const char *);
212 SQUIDCEXTERN
void helperFree(helper
*);
213 SQUIDCEXTERN
void helperStatefulFree(statefulhelper
*);
214 SQUIDCEXTERN
void helperStatefulReleaseServer(helper_stateful_server
* srv
);
215 SQUIDCEXTERN
void *helperStatefulServerGetData(helper_stateful_server
* srv
);
219 #endif /* SQUID_HELPER_H */