]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/StoreSearch.h
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
33 #ifndef SQUID_STORESEARCH_H
34 #define SQUID_STORESEARCH_H
36 #include "squid-old.h"
40 class StoreSearch
: public RefCountable
46 StoreSearch(StoreSearch
const &); /* no implementation - trigger link failures */
47 virtual ~StoreSearch() {}
50 void asList(void (*) (CbDataList<StoreEntryPointer), void *cbdata);
52 /* callback the client when a new StoreEntry is available
55 virtual void next(void (callback
)(void *cbdata
), void *cbdata
) = 0;
56 /* return true if a new StoreEntry is immediately available
57 * ???- not decided - if false, trigger making a new one available
58 * this would be for sync api users that will schedule their own callback
59 * to try again later. so if that next() has to allow multiple
60 * calls being made to it without error
62 virtual bool next() = 0;
63 virtual bool error() const = 0;
64 virtual bool isDone() const = 0;
65 virtual StoreEntry
*currentItem() = 0;
68 typedef RefCount
<StoreSearch
> StoreSearchPointer
;
70 #endif /* SQUID_STORESEARCH_H */