src/StoreIOBuffer.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_STOREIOBUFFER_H
  34 #define SQUID_STOREIOBUFFER_H
  35
  36 /* TODO: move this and the range() method into a .cci */
  37 #include "MemBuf.h"
  38 #include "Range.h"
  39
  40 class StoreIOBuffer
  41 {
  42
  43 public:
  44     StoreIOBuffer():length(0), offset (0), data (NULL) {flags.error = 0;}
  45
  46     StoreIOBuffer(size_t aLength, int64_t anOffset, char *someData) :
  47             length (aLength), offset (anOffset), data (someData) {
  48         flags.error = 0;
  49     }
  50
  51     /* Create a StoreIOBuffer from a MemBuf and offset */
  52     /* NOTE that MemBuf still "owns" the pointers, StoreIOBuffer is just borrowing them */
  53     StoreIOBuffer(MemBuf *aMemBuf, int64_t anOffset) :
  54             length(aMemBuf->contentSize()),
  55             offset (anOffset),
  56             data(aMemBuf->content()) {
  57         flags.error = 0;
  58     }
  59
  60     StoreIOBuffer(MemBuf *aMemBuf, int64_t anOffset, size_t anLength) :
  61             length(anLength),
  62             offset (anOffset),
  63             data(aMemBuf->content()) {
  64         flags.error = 0;
  65     }
  66
  67     Range<int64_t> range() const {
  68         return Range<int64_t>(offset, offset + length);
  69     }
  70
  71     void dump() const {
  72         if (fwrite(data, length, 1, stderr)) {}
  73         if (fwrite("\n", 1, 1, stderr)) {}
  74     }
  75
  76     struct {
  77         unsigned error:1;
  78     } flags;
  79     size_t length;
  80     int64_t offset;
  81     char *data;
  82 };
  83
  84 inline
  85 std::ostream &
  86 operator <<(std::ostream &os, const StoreIOBuffer &b)
  87 {
  88     return os << "ioBuf(@" << b.offset << ", len=" << b.length << ", " <<
  89            (void*)b.data << (b.flags.error ? ", ERR" : "") << ')';
  90 }
  91
  92 #endif /* SQUID_STOREIOBUFFER_H */