src/StoreMetaUnpacker.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   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.
  16  *
  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.
  21  *
  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.
  26  *
  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.
  30  *
  31  */
  32 #ifndef SQUID_TYPELENGTHVALUEUNPACKER_H
  33 #define SQUID_TYPELENGTHVALUEUNPACKER_H
  34
  35 class StoreMeta;
  36 class StoreEntry;
  37
  38 /* for ssize_t, SQUIDCEXTERN */
  39 #include "config.h"
  40
  41 class StoreMetaUnpacker
  42 {
  43
  44 public:
  45     StoreMetaUnpacker (const char *buf, ssize_t bufferLength, int *hdrlen);
  46     StoreMeta *createStoreMeta();
  47     bool isBufferSane();
  48
  49 private:
  50     static int const MinimumBufferLength;
  51
  52     void getBufferLength();
  53     void getType();
  54     void getLength();
  55     void getTLV();
  56     bool doOneEntry();
  57     bool moreToProcess() const;
  58
  59     char const * const buf;
  60     ssize_t buflen;
  61     int *hdr_len;
  62     int position;
  63     char type;
  64     int length;
  65     StoreMeta **tail;
  66 };
  67
  68 /*
  69  * store_swapmeta.c
  70  */
  71 SQUIDCEXTERN char *storeSwapMetaPack(StoreMeta * tlv_list, int *length);
  72 SQUIDCEXTERN StoreMeta *storeSwapMetaBuild(StoreEntry * e);
  73 SQUIDCEXTERN StoreMeta *storeSwapMetaUnpack(const char *buf, int *hdrlen);
  74 SQUIDCEXTERN void storeSwapTLVFree(StoreMeta * n);
  75 StoreMeta ** storeSwapTLVAdd(int type, const void *ptr, size_t len, StoreMeta ** tail);
  76
  77 #endif /* SQUID_TYPELENGTHVALUEUNPACKER_H */