]> git.ipfire.org Git - thirdparty/squid.git/blob - src/DiskIO/Blocking/BlockingFile.h
Merge auto-docs branch. pt 2
[thirdparty/squid.git] / src / DiskIO / Blocking / BlockingFile.h
1 /*
2 * $Id: BlockingFile.h,v 1.3 2008/02/26 21:49:40 amosjeffries Exp $
3 *
4 * DEBUG: section 47 Store Directory Routines
5 * AUTHOR: Robert Collins
6 *
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
9 *
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
18 *
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
23 *
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
32 *
33 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
34 */
35
36 #ifndef SQUID_BLOCKINGFILE_H
37 #define SQUID_BLOCKINGFILE_H
38
39 #include "cbdata.h"
40 #include "DiskIO/DiskFile.h"
41 #include "DiskIO/IORequestor.h"
42
43 class BlockingFile : public DiskFile
44 {
45
46 public:
47 void *operator new(size_t);
48 void operator delete(void *);
49 BlockingFile(char const *path);
50 ~BlockingFile();
51 virtual void open(int flags, mode_t mode, RefCount<IORequestor> callback);
52 virtual void create(int flags, mode_t mode, RefCount<IORequestor> callback);
53 virtual void read(ReadRequest *);
54 virtual void write(WriteRequest *);
55 virtual void close();
56 virtual bool error() const;
57 virtual int getFD() const { return fd;}
58
59 virtual bool canRead() const;
60 virtual bool ioInProgress() const;
61
62 private:
63 static DRCB ReadDone;
64 static DWCB WriteDone;
65 CBDATA_CLASS(BlockingFile);
66 int fd;
67 bool closed;
68 void error (bool const &);
69 bool error_;
70 char const *path_;
71 RefCount<IORequestor> ioRequestor;
72 RefCount<ReadRequest> readRequest;
73 RefCount<WriteRequest> writeRequest;
74 void doClose();
75 void readDone(int fd, const char *buf, int len, int errflag);
76 void writeDone(int fd, int errflag, size_t len);
77 };
78
79 #endif /* SQUID_BLOCKINGFILE_H */