StoreMeta.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_TYPELENGTHVALUE_H
#define SQUID_TYPELENGTHVALUE_H
 
class StoreEntry;
 
// WTF?
typedef class StoreMeta tlv;
 
enum {
    STORE_META_VOID,
 
    STORE_META_KEY_URL,
 
    STORE_META_KEY_SHA,
 
    STORE_META_KEY_MD5,
 
    STORE_META_URL,
 
    STORE_META_STD,
 
    STORE_META_HITMETERING,
 
    // TODO: document this TLV type code
    STORE_META_VALID,
 
    STORE_META_VARY_HEADERS,
 
    STORE_META_STD_LFS,
 
    // TODO: document this TLV type code
    STORE_META_OBJSIZE,
 
    STORE_META_STOREURL,    
    STORE_META_VARY_ID,     
    STORE_META_END
};
 
class StoreMeta
{
protected:
    StoreMeta() : length(-1), value(nullptr), next(nullptr) { }
    StoreMeta(const StoreMeta &);
    StoreMeta& operator=(const StoreMeta &);
 
public:
    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;
};
 
char *storeSwapMetaPack(tlv * tlv_list, int *length);
tlv *storeSwapMetaBuild(const StoreEntry *);
void storeSwapTLVFree(tlv * n);
 
#endif /* SQUID_TYPELENGTHVALUE_H */