src/StoreMetaUnpacker.h

   1
   2 /*
   3  * $Id: StoreMetaUnpacker.h,v 1.2 2003/02/21 22:50:06 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_TYPELENGTHVALUEUNPACKER_H
  35 #define SQUID_TYPELENGTHVALUEUNPACKER_H
  36
  37 class StoreMeta;
  38
  39 class StoreMetaUnpacker
  40 {
  41
  42 public:
  43     StoreMetaUnpacker (const char *buf, ssize_t bufferLength, int *hdrlen);
  44     StoreMeta *createStoreMeta();
  45     bool isBufferSane();
  46
  47 private:
  48     static off_t const MinimumBufferLength;
  49
  50     void getBufferLength();
  51     void getType();
  52     void getLength();
  53     void getTLV();
  54     bool doOneEntry();
  55     bool moreToProcess() const;
  56
  57     char const * const buf;
  58     ssize_t buflen;
  59     int *hdr_len;
  60     off_t position;
  61     char type;
  62     int length;
  63     StoreMeta **tail;
  64 };
  65
  66 /*
  67  * store_swapmeta.c
  68  */
  69 SQUIDCEXTERN char *storeSwapMetaPack(StoreMeta * tlv_list, int *length);
  70 SQUIDCEXTERN StoreMeta *storeSwapMetaBuild(StoreEntry * e);
  71 SQUIDCEXTERN StoreMeta *storeSwapMetaUnpack(const char *buf, int *hdrlen);
  72 SQUIDCEXTERN void storeSwapTLVFree(StoreMeta * n);
  73 StoreMeta ** storeSwapTLVAdd(int type, const void *ptr, size_t len, StoreMeta ** tail);
  74
  75 #endif /* SQUID_TYPELENGTHVALUEUNPACKER_H */