]>
Commit | Line | Data |
---|---|---|
c8be6d7b | 1 | |
2 | /* | |
47f6e231 | 3 | * $Id: StoreClient.h,v 1.15 2007/08/13 17:20:51 hno Exp $ |
c8be6d7b | 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" | |
e877aaac | 38 | #include "StoreIOState.h" |
c8be6d7b | 39 | |
40 | typedef void STCB(void *, StoreIOBuffer); /* store callback */ | |
41 | ||
3b13a8fd | 42 | class StoreEntry; |
e6ccf245 | 43 | |
62e76326 | 44 | class StoreClient |
45 | { | |
46 | ||
e6ccf245 | 47 | public: |
62e76326 | 48 | virtual ~StoreClient () {} |
49 | ||
50 | virtual void created (StoreEntry *newEntry) = 0; | |
e6ccf245 | 51 | }; |
e6ccf245 | 52 | |
b67e2c8c | 53 | #if DELAY_POOLS |
54 | #include "DelayId.h" | |
55 | #endif | |
56 | ||
c8be6d7b | 57 | /* keep track each client receiving data from that particular StoreEntry */ |
62e76326 | 58 | |
59 | class store_client | |
60 | { | |
61 | ||
528b2c61 | 62 | public: |
63 | void *operator new (size_t); | |
b001e822 | 64 | void operator delete (void *); |
528b2c61 | 65 | store_client(StoreEntry *); |
2f44bd34 | 66 | ~store_client(); |
47f6e231 | 67 | bool memReaderHasLowerOffset(int64_t) const; |
528b2c61 | 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); | |
528b2c61 | 73 | void copy(StoreEntry *, StoreIOBuffer, STCB *, void *); |
fcc35180 | 74 | void dumpStats(MemBuf * output, int clientNumber) const; |
528b2c61 | 75 | |
47f6e231 | 76 | int64_t cmp_offset; |
c8be6d7b | 77 | #if STORE_CLIENT_LIST_DEBUG |
62e76326 | 78 | |
c8be6d7b | 79 | void *owner; |
80 | #endif | |
62e76326 | 81 | |
c8be6d7b | 82 | StoreEntry *entry; /* ptr to the parent StoreEntry, argh! */ |
d3b3ab85 | 83 | StoreIOState::Pointer swapin_sio; |
62e76326 | 84 | |
85 | struct | |
86 | { | |
87 | ||
88 | unsigned int disk_io_pending: | |
89 | 1; | |
90 | ||
91 | unsigned int store_copying: | |
92 | 1; | |
93 | ||
94 | unsigned int copy_event_pending: | |
95 | 1; | |
96 | } | |
97 | ||
98 | flags; | |
c8be6d7b | 99 | #if DELAY_POOLS |
62e76326 | 100 | |
b67e2c8c | 101 | DelayId delayId; |
102 | void setDelayId(DelayId delay_id); | |
c8be6d7b | 103 | #endif |
62e76326 | 104 | |
c8be6d7b | 105 | dlink_node node; |
106 | /* Below here is private - do no alter outside storeClient calls */ | |
107 | StoreIOBuffer copyInto; | |
62e76326 | 108 | |
528b2c61 | 109 | private: |
b001e822 | 110 | CBDATA_CLASS(store_client); |
528b2c61 | 111 | void fileRead(); |
4e70dae3 | 112 | void scheduleDiskRead(); |
113 | void scheduleMemRead(); | |
114 | void scheduleRead(); | |
115 | void startSwapin(); | |
528b2c61 | 116 | void unpackHeader(char const *buf, ssize_t len); |
62e76326 | 117 | |
528b2c61 | 118 | int type; |
119 | bool object_ok; | |
62e76326 | 120 | |
90703668 | 121 | /* Until we finish stuffing code into store_client */ |
122 | ||
123 | public: | |
124 | ||
62e76326 | 125 | struct Callback |
126 | { | |
127 | Callback ():callback_handler(NULL), callback_data(NULL){} | |
128 | ||
129 | Callback (STCB *, void *); | |
90703668 | 130 | bool pending() const; |
62e76326 | 131 | STCB *callback_handler; |
132 | void *callback_data; | |
133 | } | |
134 | ||
135 | _callback; | |
c8be6d7b | 136 | }; |
137 | ||
e6ccf245 | 138 | SQUIDCEXTERN void storeClientCopy(store_client *, StoreEntry *, StoreIOBuffer, STCB *, void *); |
528b2c61 | 139 | |
c8be6d7b | 140 | |
141 | #endif /* SQUID_STORECLIENT_H */ |