src/StoreClient.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  */
  33
  34 #ifndef SQUID_STORECLIENT_H
  35 #define SQUID_STORECLIENT_H
  36
  37 #include "StoreIOBuffer.h"
  38 #include "StoreIOState.h"
  39
  40 typedef void STCB(void *, StoreIOBuffer);       /* store callback */
  41
  42 class StoreEntry;
  43
  44 class StoreClient
  45 {
  46
  47 public:
  48     virtual ~StoreClient () {}
  49
  50     virtual void created (StoreEntry *newEntry) = 0;
  51 };
  52
  53 #if USE_DELAY_POOLS
  54 #include "DelayId.h"
  55 #endif
  56
  57 /* keep track each client receiving data from that particular StoreEntry */
  58
  59 class store_client
  60 {
  61
  62 public:
  63     void *operator new (size_t);
  64     void operator delete (void *);
  65     store_client(StoreEntry *);
  66     ~store_client();
  67     bool memReaderHasLowerOffset(int64_t) const;
  68     int getType() const;
  69     void fail();
  70     void callback(ssize_t len, bool error = false);
  71     void doCopy (StoreEntry *e);
  72     void readHeader(const char *buf, ssize_t len);
  73     void readBody(const char *buf, ssize_t len);
  74     void copy(StoreEntry *, StoreIOBuffer, STCB *, void *);
  75     void dumpStats(MemBuf * output, int clientNumber) const;
  76
  77     int64_t cmp_offset;
  78 #if STORE_CLIENT_LIST_DEBUG
  79
  80     void *owner;
  81 #endif
  82
  83     StoreEntry *entry;          /* ptr to the parent StoreEntry, argh! */
  84     StoreIOState::Pointer swapin_sio;
  85
  86     struct {
  87         unsigned int disk_io_pending:1;
  88         unsigned int store_copying:1;
  89         unsigned int copy_event_pending:1;
  90     } flags;
  91
  92 #if USE_DELAY_POOLS
  93     DelayId delayId;
  94     void setDelayId(DelayId delay_id);
  95 #endif
  96
  97     dlink_node node;
  98     /* Below here is private - do no alter outside storeClient calls */
  99     StoreIOBuffer copyInto;
 100
 101 private:
 102     CBDATA_CLASS(store_client);
 103     void fileRead();
 104     void scheduleDiskRead();
 105     void scheduleMemRead();
 106     void scheduleRead();
 107     void startSwapin();
 108     void unpackHeader(char const *buf, ssize_t len);
 109
 110     int type;
 111     bool object_ok;
 112
 113     /* Until we finish stuffing code into store_client */
 114
 115 public:
 116
 117     struct Callback {
 118         Callback ():callback_handler(NULL), callback_data(NULL) {}
 119
 120         Callback (STCB *, void *);
 121         bool pending() const;
 122         STCB *callback_handler;
 123         void *callback_data;
 124     } _callback;
 125 };
 126
 127 SQUIDCEXTERN void storeClientCopy(store_client *, StoreEntry *, StoreIOBuffer, STCB *, void *);
 128
 129
 130 #endif /* SQUID_STORECLIENT_H */