2 * $Id: ESIElement.h,v 1.4 2003/08/04 22:14:40 robertc Exp $
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_ESIELEMENT_H
34 #define SQUID_ESIELEMENT_H
37 #include "ESISegment.h"
40 ESI_PROCESS_COMPLETE
= 0,
41 ESI_PROCESS_PENDING_WONTFAIL
= 1,
42 ESI_PROCESS_PENDING_MAYFAIL
= 2,
43 ESI_PROCESS_FAILED
= 3
48 struct esiTreeParent
: public RefCountable
50 virtual void provideData (ESISegment::Pointer data
, ESIElement
* source
)
52 /* make abstract when all functionality complete */
56 virtual void fail(ESIElement
* source
, char const *reason
= NULL
) {}
58 virtual ~esiTreeParent(){}
61 typedef RefCount
<esiTreeParent
> esiTreeParentPtr
;
65 class ESIElement
: public esiTreeParent
69 typedef RefCount
<ESIElement
> Pointer
;
71 /* the types we have */
72 enum ESIElementType_t
{
83 ESI_ELEMENT_OTHERWISE
,
86 static ESIElementType_t
IdentifyElement (const char *);
87 virtual bool addElement(ESIElement::Pointer
)
89 /* Don't accept children */
90 debugs(86,5, "ESIElement::addElement: Failed for " << this);
94 virtual void render (ESISegment::Pointer
) = 0;
95 /* process this element */
96 virtual esiProcessResult_t
process (int dovars
)
98 debugs(86,5, "esiProcessComplete: Processed " << this);
99 return ESI_PROCESS_COMPLETE
;
102 virtual bool mayFail() const
107 virtual Pointer
makeCacheable() const = 0;
108 virtual Pointer
makeUsable(esiTreeParentPtr
, ESIVarState
&) const = 0;
110 /* The top level no longer needs this element */
111 virtual void finish() = 0;
114 #endif /* SQUID_ESIELEMENT_H */