src/StoreIOState.h

   1
   2 /*
   3  * $Id: StoreIOState.h,v 1.7 2006/05/22 19:58:51 wessels Exp $
   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_STOREIOSTATE_H
  35 #define SQUID_STOREIOSTATE_H
  36
  37 /*
  38  * STRCB is the "store read callback".  STRCB functions are passed
  39  * to storeRead().  Examples of STRCB callbacks are:
  40  * storeClientReadBody
  41  * storeClientReadHeader
  42  */
  43 typedef void STRCB(void *their_data, const char *buf, ssize_t len);
  44
  45 /*
  46  * STFNCB is the "store file number callback."  It is called when
  47  * an underlying storage module has allocated the swap file number
  48  * and also indicates that the swap file has been opened for reading
  49  * or writing.  STFNCB functions are passed to storeCreate() and
  50  * storeOpen().  Examples of STFNCB callbacks are:
  51  * storeSwapInFileNotify
  52  * storeSwapOutFileNotify
  53  */
  54 typedef void STFNCB(void *their_data, int errflag);
  55
  56 /*
  57  * STIOCB is the "store close callback" for store files.  It is
  58  * called when the store file is closed.  STIOCB functions are
  59  * passed to storeCreate() and storeOpen(). Examples of STIOCB
  60  * callbacks are:
  61  * storeSwapOutFileClosed
  62  * storeSwapInFileClosed
  63  */
  64 typedef void STIOCB(void *their_data, int errflag);
  65
  66 #include "RefCount.h"
  67
  68 class StoreIOState : public RefCountable
  69 {
  70
  71 public:
  72     typedef RefCount<StoreIOState> Pointer;
  73
  74     /* StoreIOState does not get mempooled - it's children do */
  75     void *operator new (size_t amount);
  76     void operator delete (void *address);
  77     virtual ~StoreIOState();
  78
  79     StoreIOState();
  80
  81     off_t offset() const;
  82
  83     virtual void read_(char *buf, size_t size, off_t offset, STRCB * callback, void *callback_data) = 0;
  84     virtual void write(char const *buf, size_t size, off_t offset, FREE * free_func) = 0;
  85     virtual void close() = 0;
  86
  87     sdirno swap_dirn;
  88     sfileno swap_filen;
  89     StoreEntry *e;              /* Need this so the FS layers can play god */
  90     mode_t mode;
  91     off_t offset_;              /* current on-disk offset pointer */
  92     STFNCB *file_callback;      /* called on delayed sfileno assignments */
  93     STIOCB *callback;
  94     void *callback_data;
  95
  96     struct
  97     {
  98         STRCB *callback;
  99         void *callback_data;
 100     }
 101
 102     read;
 103
 104     struct
 105     {
 106
 107 unsigned int closing:
 108         1;      /* debugging aid */
 109     }
 110
 111     flags;
 112 };
 113
 114 StoreIOState::Pointer storeCreate(StoreEntry *, STFNCB *, STIOCB *, void *);
 115 StoreIOState::Pointer storeOpen(StoreEntry *, STFNCB *, STIOCB *, void *);
 116 SQUIDCEXTERN void storeClose(StoreIOState::Pointer);
 117 SQUIDCEXTERN void storeRead(StoreIOState::Pointer, char *, size_t, off_t, STRCB *, void *);
 118 SQUIDCEXTERN void storeIOWrite(StoreIOState::Pointer, char const *, size_t, off_t, FREE *);
 119
 120 #endif /* SQUID_STOREIOSTATE_H */