src/StoreIOBuffer.h

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