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
36 #include "squid-old.h"
37 #include "base/AsyncCall.h"
39 #include "comm/forward.h"
40 #include "ip/Address.h"
41 #include "HelperChildConfig.h"
45 typedef void HLPSCB(void *, void *lastserver
, char *buf
);
50 inline helper(const char *name
) : cmdline(NULL
), id_name(name
), eom('\n') {}
58 HelperChildConfig childs
; ///< Configuration settings for number running.
61 time_t last_queue_warn
;
63 char eom
; ///< The char which marks the end of (response) message, normally '\n'
73 CBDATA_CLASS2(helper
);
76 class statefulhelper
: public helper
79 inline statefulhelper(const char *name
) : helper(name
) {};
80 inline ~statefulhelper() {};
83 MemAllocator
*datapool
;
84 HLPSAVAIL
*IsAvailable
;
85 HLPSONEQ
*OnEmptyQueue
;
88 CBDATA_CLASS2(statefulhelper
);
92 * Fields shared between stateless and stateful helper servers.
94 class HelperServerBase
97 /** Closes pipes to the helper safely.
98 * Handles the case where the read and write pipes are the same FD.
100 void closePipesSafely();
102 /** Closes the reading pipe.
103 * If the read and write sockets are the same the write pipe will
104 * also be closed. Otherwise its left open for later handling.
106 void closeWritePipeSafely();
112 Comm::ConnectionPointer readPipe
;
113 Comm::ConnectionPointer writePipe
;
120 struct timeval dispatch_time
;
121 struct timeval answer_time
;
125 struct _helper_flags
{
127 unsigned int writing
:1;
128 unsigned int closing
:1;
129 unsigned int shutdown
:1;
130 unsigned int reserved
:1;
135 class helper_server
: public HelperServerBase
142 helper_request
**requests
;
146 unsigned int pending
;
150 CBDATA_CLASS2(helper_server
);
153 class helper_stateful_request
;
155 class helper_stateful_server
: public HelperServerBase
159 /* MemBuf writebuf; */
161 statefulhelper
*parent
;
162 helper_stateful_request
*request
;
169 void *data
; /* State data used by the calling routines */
172 CBDATA_CLASS2(helper_stateful_server
);
179 MEMPROXY_CLASS(helper_request
);
184 struct timeval dispatch_time
;
187 MEMPROXY_CLASS_INLINE(helper_request
);
189 class helper_stateful_request
193 MEMPROXY_CLASS(helper_stateful_request
);
196 int placeholder
; /* if 1, this is a dummy request waiting for a stateful helper to become available */
200 MEMPROXY_CLASS_INLINE(helper_stateful_request
);
203 SQUIDCEXTERN
void helperOpenServers(helper
* hlp
);
204 SQUIDCEXTERN
void helperStatefulOpenServers(statefulhelper
* hlp
);
205 SQUIDCEXTERN
void helperSubmit(helper
* hlp
, const char *buf
, HLPCB
* callback
, void *data
);
206 SQUIDCEXTERN
void helperStatefulSubmit(statefulhelper
* hlp
, const char *buf
, HLPSCB
* callback
, void *data
, helper_stateful_server
* lastserver
);
207 SQUIDCEXTERN
void helperStats(StoreEntry
* sentry
, helper
* hlp
, const char *label
= NULL
);
208 SQUIDCEXTERN
void helperStatefulStats(StoreEntry
* sentry
, statefulhelper
* hlp
, const char *label
= NULL
);
209 SQUIDCEXTERN
void helperShutdown(helper
* hlp
);
210 SQUIDCEXTERN
void helperStatefulShutdown(statefulhelper
* hlp
);
211 SQUIDCEXTERN
void helperStatefulReleaseServer(helper_stateful_server
* srv
);
212 SQUIDCEXTERN
void *helperStatefulServerGetData(helper_stateful_server
* srv
);
215 #endif /* SQUID_HELPER_H */