src/DiskIO/AIO/AIODiskFile.h

   1 /*
   2  * $Id: AIODiskFile.h,v 1.5 2008/02/26 21:49:40 amosjeffries Exp $
   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_AIODISKFILE_H
  34 #define SQUID_AIODISKFILE_H
  35
  36 #include "DiskIO/DiskFile.h"
  37 #include "async_io.h"
  38 #include "cbdata.h"
  39
  40 class AIODiskIOStrategy;
  41
  42 class AIODiskFile : public DiskFile
  43 {
  44
  45 public:
  46
  47     friend class AIODiskIOStrategy;
  48     void * operator new (size_t);
  49     void operator delete (void *);
  50     AIODiskFile (char const *path, AIODiskIOStrategy *);
  51     ~AIODiskFile();
  52
  53     /// \bug the code has this as "IORequestor::Pointer callback"
  54     virtual void open(int flags, mode_t mode, RefCount<IORequestor> callback);
  55
  56     virtual void create (int, mode_t, RefCount<IORequestor>);
  57     virtual void read(ReadRequest *);
  58     virtual void write(WriteRequest *);
  59     virtual void close ();
  60     virtual bool canRead() const;
  61     virtual bool canWrite() const;
  62
  63     /* During migration only */
  64     virtual int getFD() const;
  65
  66     virtual bool error() const;
  67
  68     /* Inform callers if there is IO in progress */
  69     virtual bool ioInProgress() const;
  70
  71 private:
  72     CBDATA_CLASS(AIODiskFile);
  73     void error(bool const &);
  74     int fd;
  75     String path;
  76     AIODiskIOStrategy *strategy;
  77     RefCount<IORequestor> ioRequestor;
  78     bool closed;
  79     bool error_;
  80 };
  81
  82 #endif /* SQUID_AIODISKFILE_H */