]>
Commit | Line | Data |
---|---|---|
59b2d47f | 1 | /* |
262a0e14 | 2 | * $Id$ |
59b2d47f | 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. | |
26ac0430 | 20 | * |
59b2d47f | 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. | |
26ac0430 | 25 | * |
59b2d47f | 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 | * | |
b9ae18aa | 30 | * Copyright (c) 2003 Robert Collins <robertc@squid-cache.org> |
59b2d47f | 31 | */ |
32 | ||
b9ae18aa | 33 | #ifndef SQUID_DISKFILE_H |
34 | #define SQUID_DISKFILE_H | |
59b2d47f | 35 | |
582c2af2 | 36 | #include "typedefs.h" |
59b2d47f | 37 | |
b9ae18aa | 38 | #include "RefCount.h" |
59b2d47f | 39 | |
b9ae18aa | 40 | class IORequestor; |
41 | ||
42 | class ReadRequest; | |
43 | ||
44 | class WriteRequest; | |
45 | ||
46 | class DiskFile : public RefCountable | |
59b2d47f | 47 | { |
48 | ||
49 | public: | |
43ebbac3 AR |
50 | |
51 | /// generally useful configuration options supported by some children | |
fc4dadeb A |
52 | class Config |
53 | { | |
43ebbac3 | 54 | public: |
df881a0f | 55 | Config(): ioTimeout(0), ioRate(-1) {} |
43ebbac3 AR |
56 | |
57 | /// canRead/Write should return false if expected I/O delay exceeds it | |
58 | time_msec_t ioTimeout; // not enforced if zero, which is the default | |
df881a0f AR |
59 | |
60 | /// shape I/O request stream to approach that many per second | |
61 | int ioRate; // not enforced if negative, which is the default | |
43ebbac3 AR |
62 | }; |
63 | ||
b9ae18aa | 64 | typedef RefCount<DiskFile> Pointer; |
63be0a78 | 65 | |
43ebbac3 AR |
66 | /// notes supported configuration options; kids must call this first |
67 | virtual void configure(const Config &cfg) {} | |
68 | ||
63be0a78 | 69 | virtual void open(int flags, mode_t mode, RefCount<IORequestor> callback) = 0; |
70 | virtual void create(int flags, mode_t mode, RefCount<IORequestor> callback) = 0; | |
b9ae18aa | 71 | virtual void read(ReadRequest *) = 0; |
72 | virtual void write(WriteRequest *) = 0; | |
63be0a78 | 73 | virtual void close() = 0; |
b9ae18aa | 74 | virtual bool canRead() const = 0; |
75 | virtual bool canWrite() const {return true;} | |
59b2d47f | 76 | |
63be0a78 | 77 | /** During migration only */ |
b9ae18aa | 78 | virtual int getFD() const {return -1;} |
79 | ||
80 | virtual bool error() const = 0; | |
59b2d47f | 81 | |
63be0a78 | 82 | /** Inform callers if there is IO in progress */ |
b9ae18aa | 83 | virtual bool ioInProgress() const = 0; |
84 | }; | |
59b2d47f | 85 | |
b9ae18aa | 86 | #endif /* SQUID_DISKFILE_H */ |