]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/StoreClient.h
6 * SQUID Web Proxy Cache http://www.squid-cache.org/
7 * ----------------------------------------------------------
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.
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.
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.
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.
34 #ifndef SQUID_STORECLIENT_H
35 #define SQUID_STORECLIENT_H
37 #include "StoreIOBuffer.h"
38 #include "StoreIOState.h"
40 typedef void STCB(void *, StoreIOBuffer
); /* store callback */
48 virtual ~StoreClient () {}
50 virtual void created (StoreEntry
*newEntry
) = 0;
57 /* keep track each client receiving data from that particular StoreEntry */
63 void *operator new (size_t);
64 void operator delete (void *);
65 store_client(StoreEntry
*);
67 bool memReaderHasLowerOffset(int64_t) const;
70 void callback(ssize_t len
, bool error
= false);
71 void doCopy (StoreEntry
*e
);
72 void readHeader(const char *buf
, ssize_t len
);
73 void copy(StoreEntry
*, StoreIOBuffer
, STCB
*, void *);
74 void dumpStats(MemBuf
* output
, int clientNumber
) const;
77 #if STORE_CLIENT_LIST_DEBUG
82 StoreEntry
*entry
; /* ptr to the parent StoreEntry, argh! */
83 StoreIOState::Pointer swapin_sio
;
86 unsigned int disk_io_pending
:1;
87 unsigned int store_copying
:1;
88 unsigned int copy_event_pending
:1;
93 void setDelayId(DelayId delay_id
);
97 /* Below here is private - do no alter outside storeClient calls */
98 StoreIOBuffer copyInto
;
101 CBDATA_CLASS(store_client
);
103 void scheduleDiskRead();
104 void scheduleMemRead();
107 void unpackHeader(char const *buf
, ssize_t len
);
112 /* Until we finish stuffing code into store_client */
117 Callback ():callback_handler(NULL
), callback_data(NULL
) {}
119 Callback (STCB
*, void *);
120 bool pending() const;
121 STCB
*callback_handler
;
126 SQUIDCEXTERN
void storeClientCopy(store_client
*, StoreEntry
*, StoreIOBuffer
, STCB
*, void *);
129 #endif /* SQUID_STORECLIENT_H */