]>
Commit | Line | Data |
---|---|---|
c824c43b | 1 | |
2 | /* | |
3 | * $Id: ICAPLauncher.h,v 1.1 2007/05/08 16:32:11 rousskov Exp $ | |
4 | * | |
5 | * | |
6 | * SQUID Web Proxy Cache http://www.squid-cache.org/ | |
7 | * ---------------------------------------------------------- | |
8 | * | |
9 | * Squid is the result of efforts by numerous individuals from | |
10 | * the Internet community; see the CONTRIBUTORS file for full | |
11 | * details. Many organizations have provided support for Squid's | |
12 | * development; see the SPONSORS file for full details. Squid is | |
13 | * Copyrighted (C) 2001 by the Regents of the University of | |
14 | * California; see the COPYRIGHT file for full details. Squid | |
15 | * incorporates software developed and/or copyrighted by other | |
16 | * sources; see the CREDITS file for full details. | |
17 | * | |
18 | * This program is free software; you can redistribute it and/or modify | |
19 | * it under the terms of the GNU General Public License as published by | |
20 | * the Free Software Foundation; either version 2 of the License, or | |
21 | * (at your option) any later version. | |
22 | * | |
23 | * This program is distributed in the hope that it will be useful, | |
24 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
26 | * GNU General Public License for more details. | |
27 | * | |
28 | * You should have received a copy of the GNU General Public License | |
29 | * along with this program; if not, write to the Free Software | |
30 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. | |
31 | * | |
32 | */ | |
33 | ||
34 | #ifndef SQUID_ICAPLAUNCHER_H | |
35 | #define SQUID_ICAPLAUNCHER_H | |
36 | ||
37 | #include "ICAP/ICAPInitiator.h" | |
38 | #include "ICAP/ICAPInitiate.h" | |
39 | ||
40 | /* | |
41 | * The ICAP Launcher starts an ICAP transaction. If the transaction fails | |
42 | * due to what looks like a persistent connection race condition, the launcher | |
43 | * starts a new ICAP transaction using a freshly opened connection. | |
44 | * | |
45 | * ICAPLauncher and one or more ICAP transactions initiated by it form an | |
46 | * ICAP "query". | |
47 | * | |
48 | * An ICAP Initiator deals with the ICAP Launcher and not an individual ICAP | |
49 | * transaction because the latter may disappear and be replaced by another | |
50 | * transaction. | |
51 | * | |
52 | * Specific ICAP launchers implement the createXaction() method to create | |
53 | * REQMOD, RESPMOD, or OPTIONS transaction from initiator-supplied data. | |
54 | * | |
55 | * TODO: This class might be the right place to initiate ICAP ACL checks or | |
56 | * implement more sophisticated ICAP transaction handling like chaining of | |
57 | * ICAP transactions. | |
58 | */ | |
59 | ||
60 | class ICAPXaction; | |
61 | ||
62 | // Note: ICAPInitiate must be the first parent for cbdata to work. We use | |
63 | // a temporary ICAPInitaitorHolder/toCbdata hacks and do not call cbdata | |
64 | // operations on the initiator directly. | |
65 | class ICAPLauncher: public ICAPInitiate, public ICAPInitiator | |
66 | { | |
67 | public: | |
68 | ICAPLauncher(const char *aTypeName, ICAPInitiator *anInitiator, ICAPServiceRep::Pointer &aService); | |
69 | virtual ~ICAPLauncher(); | |
70 | ||
71 | // ICAPInitiate: asynchronous communication with the initiator | |
72 | void noteInitiatorAborted(); | |
73 | ||
74 | // ICAPInitiator: asynchronous communication with the current transaction | |
75 | virtual void noteIcapAnswer(HttpMsg *message); | |
76 | virtual void noteIcapQueryAbort(bool final); | |
77 | ||
78 | // a temporary cbdata-for-multiple inheritance hack, see ICAPInitiator.cc | |
79 | virtual void *toCbdata() { return this; } | |
80 | ||
81 | protected: | |
82 | // ICAPInitiate API implementation | |
83 | virtual void start(); | |
84 | virtual bool doneAll() const; | |
85 | virtual void swanSong(); | |
86 | ||
87 | // creates the right ICAP transaction using stored configuration params | |
88 | virtual ICAPXaction *createXaction() = 0; | |
89 | ||
90 | void launchXaction(bool final); | |
91 | ||
92 | ICAPInitiate *theXaction; // current ICAP transaction | |
93 | int theLaunches; // the number of transaction launches | |
94 | }; | |
95 | ||
96 | #endif /* SQUID_ICAPLAUNCHER_H */ |