src/StoreMetaUnpacker.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  */
  30 #ifndef SQUID_TYPELENGTHVALUEUNPACKER_H
  31 #define SQUID_TYPELENGTHVALUEUNPACKER_H
  32
  33 class StoreMeta;
  34 class StoreEntry;
  35
  36 class StoreMetaUnpacker
  37 {
  38
  39 public:
  40     StoreMetaUnpacker (const char *buf, ssize_t bufferLength, int *hdrlen);
  41     StoreMeta *createStoreMeta();
  42     bool isBufferZero(); ///< all-zeros buffer, implies !isBufferSane
  43     bool isBufferSane();
  44
  45 private:
  46     static int const MinimumBufferLength;
  47
  48     void getBufferLength();
  49     void getType();
  50     void getLength();
  51     void getTLV();
  52     bool doOneEntry();
  53     bool moreToProcess() const;
  54
  55     char const * const buf;
  56     ssize_t buflen;
  57     int *hdr_len;
  58     int position;
  59     char type;
  60     int length;
  61     StoreMeta **tail;
  62 };
  63
  64 /*
  65  * store_swapmeta.c
  66  */
  67 SQUIDCEXTERN char *storeSwapMetaPack(StoreMeta * tlv_list, int *length);
  68 SQUIDCEXTERN StoreMeta *storeSwapMetaBuild(StoreEntry * e);
  69 SQUIDCEXTERN StoreMeta *storeSwapMetaUnpack(const char *buf, int *hdrlen);
  70 SQUIDCEXTERN void storeSwapTLVFree(StoreMeta * n);
  71 StoreMeta ** storeSwapTLVAdd(int type, const void *ptr, size_t len, StoreMeta ** tail);
  72
  73 #endif /* SQUID_TYPELENGTHVALUEUNPACKER_H */