src/stmem.h

   1
   2 /*
   3  * $Id: stmem.h,v 1.4 2003/06/26 12:51:57 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  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34
  35 #ifndef SQUID_STMEM_H
  36 #define SQUID_STMEM_H
  37
  38 #include "splay.h"
  39 #include "Range.h"
  40
  41 class mem_node;
  42
  43 class StoreIOBuffer;
  44
  45 class mem_hdr
  46 {
  47
  48 public:
  49     mem_hdr();
  50     ~mem_hdr();
  51     void freeContent();
  52     int lowestOffset () const;
  53     off_t endOffset () const;
  54     int freeDataUpto (int);
  55     ssize_t copy (off_t, char *, size_t) const;
  56     bool hasContigousContentRange(Range<size_t> const &range) const;
  57     /* success or fail */
  58     bool write (StoreIOBuffer const &);
  59     void dump() const;
  60     size_t size() const;
  61     /* Not an iterator - thus the start, not begin() */
  62     mem_node const *start() const;
  63     mem_node *getBlockContainingLocation (size_t location) const;
  64
  65     /* Only for use of MemObject */
  66     void internalAppend(const char *data, int len);
  67
  68     static SplayNode<mem_node *>::SPLAYCMP NodeCompare;
  69
  70 private:
  71     void unlink(mem_node *aNode);
  72     void makeAppendSpace();
  73     int appendToNode(mem_node *aNode, const char *data, int maxLength);
  74     void appendNode (mem_node *aNode);
  75     size_t copyAvailable(mem_node *aNode, size_t location, size_t amount, char *target) const;
  76     bool unionNotEmpty (StoreIOBuffer const &);
  77     mem_node *nodeToRecieve(off_t offset);
  78     size_t writeAvailable(mem_node *aNode, size_t location, size_t amount, char const *source);
  79     off_t inmem_hi;
  80     Splay<mem_node *> nodes;
  81 };
  82
  83 #endif /* SQUID_STMEM_H */