src/esi/Segment.h

   1 /*
   2  * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_ESISEGMENT_H
  10 #define SQUID_ESISEGMENT_H
  11
  12 /* TODO: Factor the store memory segment management into a reusable code block
  13  * or perhaps use membuffers here?
  14  */
  15
  16 #include "base/RefCount.h"
  17 #include "cbdata.h"
  18 #include "http/forward.h"
  19 #include "SquidString.h"
  20
  21 class ESISegment : public RefCountable
  22 {
  23     CBDATA_CLASS(ESISegment);
  24
  25 public:
  26     typedef RefCount<ESISegment> Pointer;
  27     static void ListAppend (Pointer &, char const *, size_t);
  28     static void ListTransfer (Pointer &from, Pointer &to);
  29
  30     ESISegment() : len(0), next(nullptr) {*buf = 0;}
  31     ESISegment(ESISegment const &);
  32     ~ESISegment() override {}
  33
  34     ESISegment::Pointer cloneList() const;
  35     char *listToChar() const;
  36     void listAppend (char const *s, size_t length);
  37     void adsorbList (ESISegment::Pointer from);
  38     size_t space() const;
  39
  40     char buf[HTTP_REQBUF_SZ];
  41     size_t len; /* how much data has been pushed into this */
  42     Pointer next;
  43     size_t append(char const *, size_t);
  44     size_t append (Pointer);
  45     ESISegment const *tail() const;
  46     ESISegment *tail();
  47     void dumpToLog() const;
  48
  49 private:
  50     size_t listLength()const;
  51     void dumpOne() const;
  52 };
  53
  54 void ESISegmentFreeList (ESISegment::Pointer &head);
  55
  56 #endif /* SQUID_ESISEGMENT_H */
  57