src/stmem.h

   1
   2 /*
   3  *
   4  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   5  * ----------------------------------------------------------
   6  *
   7  *  Squid is the result of efforts by numerous individuals from
   8  *  the Internet community; see the CONTRIBUTORS file for full
   9  *  details.   Many organizations have provided support for Squid's
  10  *  development; see the SPONSORS file for full details.  Squid is
  11  *  Copyrighted (C) 2001 by the Regents of the University of
  12  *  California; see the COPYRIGHT file for full details.  Squid
  13  *  incorporates software developed and/or copyrighted by other
  14  *  sources; see the CREDITS file for full details.
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License as published by
  18  *  the Free Software Foundation; either version 2 of the License, or
  19  *  (at your option) any later version.
  20  *
  21  *  This program is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  *  GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License
  27  *  along with this program; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  29  *
  30  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  31  */
  32
  33 #ifndef SQUID_STMEM_H
  34 #define SQUID_STMEM_H
  35
  36 #include "Range.h"
  37 #include "splay.h"
  38
  39 class mem_node;
  40
  41 class StoreIOBuffer;
  42
  43 class mem_hdr
  44 {
  45
  46 public:
  47     mem_hdr();
  48     ~mem_hdr();
  49     void freeContent();
  50     int64_t lowestOffset () const;
  51     int64_t endOffset () const;
  52     int64_t freeDataUpto (int64_t);
  53     ssize_t copy (StoreIOBuffer const &) const;
  54     bool hasContigousContentRange(Range<int64_t> const &range) const;
  55     /* success or fail */
  56     bool write (StoreIOBuffer const &);
  57     void dump() const;
  58     size_t size() const;
  59     /* Not an iterator - thus the start, not begin() */
  60     mem_node const *start() const;
  61     mem_node *getBlockContainingLocation (int64_t location) const;
  62     /* access the contained nodes - easier than punning
  63      * as a contianer ourselves
  64      */
  65     const Splay<mem_node *> &getNodes() const;
  66     char * NodeGet(mem_node * aNode);
  67
  68     /* Only for use of MemObject */
  69     void internalAppend(const char *data, int len);
  70
  71     static SplayNode<mem_node *>::SPLAYCMP NodeCompare;
  72
  73 private:
  74     void debugDump() const;
  75     bool unlink(mem_node *aNode);
  76     void makeAppendSpace();
  77     int appendToNode(mem_node *aNode, const char *data, int maxLength);
  78     void appendNode (mem_node *aNode);
  79     size_t copyAvailable(mem_node *aNode, int64_t location, size_t amount, char *target) const;
  80     bool unionNotEmpty (StoreIOBuffer const &);
  81     mem_node *nodeToRecieve(int64_t offset);
  82     size_t writeAvailable(mem_node *aNode, int64_t location, size_t amount, char const *source);
  83     int64_t inmem_hi;
  84     Splay<mem_node *> nodes;
  85 };
  86
  87 #endif /* SQUID_STMEM_H */