[thirdparty/squid.git] / src / Server.h


/*
 * $Id: Server.h,v 1.2 2006/10/31 23:30:56 wessels Exp $
 *
 * AUTHOR: Duane Wessels
 *
 * SQUID Web Proxy Cache          http://www.squid-cache.org/
 * ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from
 *  the Internet community; see the CONTRIBUTORS file for full
 *  details.   Many organizations have provided support for Squid's
 *  development; see the SPONSORS file for full details.  Squid is
 *  Copyrighted (C) 2001 by the Regents of the University of
 *  California; see the COPYRIGHT file for full details.  Squid
 *  incorporates software developed and/or copyrighted by other
 *  sources; see the CREDITS file for full details.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *  
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 */

/*
 * ServerStateData is a class for common elements of Server-side modules
 * such as http.cc and ftp.cc.  It was invented to make ICAP code simpler.
 */

#ifndef SQUID_SERVER_H
#define SQUID_SERVER_H

#include "StoreIOBuffer.h"
#include "forward.h"

#if ICAP_CLIENT
#include "ICAP/ICAPServiceRep.h"

class ICAPClientRespmodPrecache;

class ICAPAccessCheck;
#endif

class ServerStateData
{

public:
    ServerStateData(FwdState *);
    virtual ~ServerStateData();

#if ICAP_CLIENT
    virtual bool takeAdaptedHeaders(HttpReply *) = 0;
    virtual bool takeAdaptedBody(MemBuf *) = 0;
    virtual void finishAdapting() = 0;
    virtual void abortAdapting() = 0;
    virtual void icapSpaceAvailable() = 0;
    virtual void icapAclCheckDone(ICAPServiceRep::Pointer) = 0;
#endif

public:
    // should be protected
    StoreEntry *entry;
    FwdState::Pointer fwd;
    HttpRequest *request;
    HttpReply *reply;

protected:
#if ICAP_CLIENT

    ICAPClientRespmodPrecache *icap;
    bool icapAccessCheckPending;
    bool startIcap(ICAPServiceRep::Pointer);
#endif

};

#endif /* SQUID_SERVER_H */
Commit	Line	Data
cd304fc2	1
cd304fc2	2	/*
c99de607	3	* $Id: Server.h,v 1.2 2006/10/31 23:30:56 wessels Exp $
cd304fc2	4	*
	5	* AUTHOR: Duane Wessels
	6	*
	7	* SQUID Web Proxy Cache http://www.squid-cache.org/
	8	* ----------------------------------------------------------
	9	*
	10	* Squid is the result of efforts by numerous individuals from
	11	* the Internet community; see the CONTRIBUTORS file for full
	12	* details. Many organizations have provided support for Squid's
	13	* development; see the SPONSORS file for full details. Squid is
	14	* Copyrighted (C) 2001 by the Regents of the University of
	15	* California; see the COPYRIGHT file for full details. Squid
	16	* incorporates software developed and/or copyrighted by other
	17	* sources; see the CREDITS file for full details.
	18	*
	19	* This program is free software; you can redistribute it and/or modify
	20	* it under the terms of the GNU General Public License as published by
	21	* the Free Software Foundation; either version 2 of the License, or
	22	* (at your option) any later version.
	23	*
	24	* This program is distributed in the hope that it will be useful,
	25	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	26	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	27	* GNU General Public License for more details.
	28	*
	29	* You should have received a copy of the GNU General Public License
	30	* along with this program; if not, write to the Free Software
	31	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
	32	*
	33	*/
	34
	35	/*
	36	* ServerStateData is a class for common elements of Server-side modules
	37	* such as http.cc and ftp.cc. It was invented to make ICAP code simpler.
	38	*/
	39
	40	#ifndef SQUID_SERVER_H
	41	#define SQUID_SERVER_H
	42
	43	#include "StoreIOBuffer.h"
	44	#include "forward.h"
	45
	46	#if ICAP_CLIENT
	47	#include "ICAP/ICAPServiceRep.h"
	48
	49	class ICAPClientRespmodPrecache;
	50
	51	class ICAPAccessCheck;
	52	#endif
	53
	54	class ServerStateData
	55	{
	56
	57	public:
	58	ServerStateData(FwdState *);
	59	virtual ~ServerStateData();
	60
	61	#if ICAP_CLIENT
c99de607	62	virtual bool takeAdaptedHeaders(HttpReply *) = 0;
	63	virtual bool takeAdaptedBody(MemBuf *) = 0;
	64	virtual void finishAdapting() = 0;
cd304fc2	65	virtual void abortAdapting() = 0;
	66	virtual void icapSpaceAvailable() = 0;
	67	virtual void icapAclCheckDone(ICAPServiceRep::Pointer) = 0;
	68	#endif
	69
	70	public:
	71	// should be protected
	72	StoreEntry *entry;
	73	FwdState::Pointer fwd;
	74	HttpRequest *request;
	75	HttpReply *reply;
	76
	77	protected:
	78	#if ICAP_CLIENT
	79
	80	ICAPClientRespmodPrecache *icap;
	81	bool icapAccessCheckPending;
c99de607	82	bool startIcap(ICAPServiceRep::Pointer);
cd304fc2	83	#endif
	84
	85	};
	86
	87	#endif /* SQUID_SERVER_H */