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


/*
 * $Id: StoreMeta.h,v 1.1 2003/01/23 00:37:14 robertc Exp $
 *
 *
 * 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.
 *
 */

#ifndef SQUID_TYPELENGTHVALUE_H
#define SQUID_TYPELENGTHVALUE_H

class StoreEntry;
typedef class StoreMeta tlv;
class StoreMeta {
public:
    virtual void deleteSelf() = 0;
    static bool validType(char);
    static int const MaximumTLVLength;
    static int const MinimumTLVLength;
    static StoreMeta *Factory (char type, size_t len, void const *value);
    static StoreMeta **Add(StoreMeta **tail, StoreMeta *aNode);
    static void FreeList (StoreMeta **head);
    
    virtual char getType() const = 0;
    virtual bool validLength(int) const;
    virtual bool checkConsistency(StoreEntry *) const;
    virtual ~StoreMeta(){}
    
    int length;
    void *value;
    tlv *next;
private:
};

/*
 * store_swapmeta.c
 */
SQUIDCEXTERN char *storeSwapMetaPack(tlv * tlv_list, int *length);
SQUIDCEXTERN tlv *storeSwapMetaBuild(StoreEntry * e);
SQUIDCEXTERN void storeSwapTLVFree(tlv * n);

#endif /* SQUID_TYPELENGTHVALUE_H */
Commit	Line	Data
528b2c61	1
	2	/*
	3	* $Id: StoreMeta.h,v 1.1 2003/01/23 00:37:14 robertc 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_TYPELENGTHVALUE_H
	35	#define SQUID_TYPELENGTHVALUE_H
	36
	37	class StoreEntry;
	38	typedef class StoreMeta tlv;
	39	class StoreMeta {
	40	public:
	41	virtual void deleteSelf() = 0;
	42	static bool validType(char);
	43	static int const MaximumTLVLength;
	44	static int const MinimumTLVLength;
	45	static StoreMeta Factory (char type, size_t len, void const value);
	46	static StoreMeta Add(StoreMeta tail, StoreMeta *aNode);
	47	static void FreeList (StoreMeta **head);
	48
	49	virtual char getType() const = 0;
	50	virtual bool validLength(int) const;
	51	virtual bool checkConsistency(StoreEntry *) const;
	52	virtual ~StoreMeta(){}
	53
	54	int length;
	55	void *value;
	56	tlv *next;
	57	private:
	58	};
	59
	60	/*
	61	* store_swapmeta.c
	62	*/
	63	SQUIDCEXTERN char storeSwapMetaPack(tlv tlv_list, int *length);
	64	SQUIDCEXTERN tlv storeSwapMetaBuild(StoreEntry e);
65	SQUIDCEXTERN void storeSwapTLVFree(tlv * n);
66
67	#endif /* SQUID_TYPELENGTHVALUE_H */