stub_store.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #include "squid.h"
10 #include "RequestFlags.h"
11 
12 #define STUB_API "store.cc"
13 #include "tests/STUB.h"
14 
15 const char *storeStatusStr[] = { };
16 const char *pingStatusStr[] = { };
17 const char *memStatusStr[] = { };
18 const char *swapStatusStr[] = { };
19 
20 #include "RemovalPolicy.h"
22 
23 #include "Store.h"
25 bool StoreEntry::checkDeferRead(int) const STUB_RETVAL(false)
26 const char *StoreEntry::getMD5Text() const STUB_RETVAL(nullptr)
31 size_t StoreEntry::bytesWanted(Range<size_t> const, bool) const STUB_RETVAL(0)
32 void StoreEntry::complete() STUB
34 char const *StoreEntry::getSerialisedMetaData(size_t &) const STUB_RETVAL(nullptr)
37 void StoreEntry::trimMemory(const bool) STUB
38 void StoreEntry::abort() STUB
40 void StoreEntry::makePrivate(const bool) STUB
42 void StoreEntry::setPrivateKey(const bool, const bool) STUB
44 void StoreEntry::releaseRequest(const bool) STUB
47 void StoreEntry::swapOut() STUB
49 const char *StoreEntry::url() const STUB_RETVAL(nullptr)
52 int StoreEntry::validToSend() const STUB_RETVAL(0)
55 void StoreEntry::createMemObject(const char *, const char *, const HttpRequestMethod &) STUB
56 void StoreEntry::ensureMemObject(const char *, const char *, const HttpRequestMethod &) STUB
57 void StoreEntry::dump(int) const STUB
59 void StoreEntry::hashInsert(const cache_key *) STUB
60 void StoreEntry::registerAbortCallback(const AsyncCall::Pointer &) STUB
61 void StoreEntry::reset() STUB
64 void StoreEntry::unregisterAbortCallback(const char *) STUB
67 void StoreEntry::setNoDelay (bool const) STUB
68 bool StoreEntry::modifiedSince(const time_t, const int) const STUB_RETVAL(false)
71 Store::Disk &StoreEntry::disk() const STUB_RETREF(Store::Disk)
73 void *StoreEntry::operator new(size_t)
74 {
75  STUB
76  return new StoreEntry();
77 }
78 void StoreEntry::operator delete(void *) STUB
79 //#if USE_SQUID_ESI
80 //ESIElement::Pointer StoreEntry::cachedESITree STUB_RETVAL(nullptr)
81 //#endif
83 void StoreEntry::flush() STUB
84 int StoreEntry::unlock(const char *) STUB_RETVAL(0)
85 void StoreEntry::lock(const char *) STUB
86 void StoreEntry::touch() STUB
87 void StoreEntry::release(const bool) STUB
88 void StoreEntry::append(char const *, int) STUB
89 void StoreEntry::vappendf(const char *, va_list) STUB
91 
92 void Store::Maintain(void *) STUB
93 
94 std::ostream &operator <<(std::ostream &os, const StoreEntry &)
95 {
96  STUB
97  return os;
98 }
99 
102 StoreEntry *storeGetPublic(const char *, const HttpRequestMethod&) STUB_RETVAL(nullptr)
105 StoreEntry *storeCreateEntry(const char *, const char *, const RequestFlags &, const HttpRequestMethod&) STUB_RETVAL(nullptr)
106 StoreEntry *storeCreatePureEntry(const char *, const char *, const HttpRequestMethod&) STUB_RETVAL(nullptr)
107 void storeConfigure(void) STUB
108 int expiresMoreThan(time_t, time_t) STUB_RETVAL(0)
109 void storeAppendPrintf(StoreEntry *, const char *,...) STUB
110 void storeAppendVPrintf(StoreEntry *, const char *, va_list) STUB
114 void storeFsInit(void) STUB
115 void storeFsDone(void) STUB
116 void storeReplAdd(const char *, REMOVALPOLICYCREATE *) STUB
117 void destroyStoreEntry(void *) STUB
118 void storeGetMemSpace(int) STUB
119 
void makePrivate(const bool shareable)
Definition: store.cc:171
void Maintain(void *unused)
Definition: store.cc:1108
virtual void buffer()
Definition: store.cc:1579
int checkTooSmall()
Definition: store.cc:876
store_client_t storeClientType() const
Definition: store.cc:248
void storeReplAdd(const char *type, REMOVALPOLICYCREATE *create)
Definition: store.cc:1623
void ensureMemObject(const char *storeId, const char *logUri, const HttpRequestMethod &aMethod)
initialize mem_obj (if needed) and set URIs/method (if missing)
Definition: store.cc:1567
void unregisterAbortCallback(const char *reason)
Definition: store.cc:1467
void releaseRequest(const bool shareable=false)
Definition: store.cc:433
manages a single cache_dir
Definition: Disk.h:22
unsigned char cache_key
Store key.
Definition: forward.h:29
bool makePublic(const KeyScope keyScope=ksDefault)
Definition: store.cc:164
StoreEntry()
Definition: store.cc:311
virtual void flush()
Definition: store.cc:1590
const char * swapStatusStr[]
Definition: stub_store.cc:18
const char * url() const
Definition: store.cc:1544
void createMemObject()
Definition: store.cc:1553
void storeAppendPrintf(StoreEntry *e, const char *fmt,...)
Definition: store.cc:830
void lock(const char *context)
Definition: store.cc:420
void touch()
update last reference timestamp and related Store metadata
Definition: store.cc:427
void setPrivateKey(const bool shareable, const bool permanent)
Definition: store.cc:523
bool setPublicKey(const KeyScope keyScope=ksDefault)
Definition: store.cc:550
const char * memStatusStr[]
Definition: stub_store.cc:17
void storeGetMemSpace(int size)
Definition: store.cc:1096
bool isAccepting() const
Definition: store.cc:1951
void replaceHttpReply(const HttpReplyPointer &, const bool andStartWriting=true)
Definition: store.cc:1683
const char * storeStatusStr[]
Definition: stub_store.cc:15
void storeFsInit(void)
Definition: store.cc:1614
void reset()
Definition: store.cc:1599
StoreEntry * storeGetPublicByRequest(HttpRequest *req, const KeyScope keyScope)
Definition: store.cc:491
bool mayStartSwapOut()
whether we may start writing to disk (now or in the future)
void destroyMemObject()
Definition: store.cc:359
StoreIoStats store_io_stats
Definition: store_io.cc:16
StoreEntry * storeGetPublicByRequestMethod(HttpRequest *req, const HttpRequestMethod &method, const KeyScope keyScope)
Definition: store.cc:485
Definition: Range.h:19
enum _mem_status_t mem_status_t
int validToSend() const
Definition: store.cc:1331
size_t HttpReply *STUB StoreEntry const KeyScope const HttpRequestMethod const KeyScope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void storeAppendVPrintf(StoreEntry *, const char *, va_list) STUB int storeTooManyDiskFilesOpen(void) STUB_RETVAL(0) void storeHeapPositionUpdate(StoreEntry *
Definition: store.cc:840
size_t HttpReply *STUB StoreEntry const KeyScope const HttpRequestMethod const KeyScope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void SwapDir *STUB void storeSwapFileNumberSet(StoreEntry *, sfileno) STUB void storeFsInit(void) STUB void storeFsDone(void) STUB void storeReplAdd(const char *
@ STORE_NON_CLIENT
Definition: enums.h:72
bool hasIfNoneMatchEtag(const HttpRequest &request) const
has ETag matching at least one of the If-None-Match etags
Definition: store.cc:1842
void abort()
Definition: store.cc:1052
store_client_t
Definition: enums.h:71
void setCollapsingRequirement(const bool required)
allow or forbid collapsed requests feeding
Definition: store.cc:1975
const char * getSerialisedMetaData(size_t &length) const
Definition: store.cc:1730
int unlock(const char *context)
Definition: store.cc:444
void expireNow()
Definition: store.cc:748
#define STUB_RETREF(x)
Definition: STUB.h:51
static size_t inUseCount()
Definition: store.cc:196
FREE destroyStoreEntry
int checkNegativeHit() const
Definition: store.cc:1274
size_t HttpReply *STUB StoreEntry const KeyScope STUB_RETVAL(nullptr) StoreEntry *storeGetPublicByRequestMethod(HttpRequest *
void write(StoreIOBuffer)
Definition: store.cc:755
bool checkCachable()
Definition: store.cc:904
#define STUB
macro to stub a void function.
Definition: STUB.h:33
bool cacheNegatively()
Definition: store.cc:185
Store statistics related to low-level I/O.
Definition: StoreStats.h:58
void dump(int debug_lvl) const
Definition: store.cc:1477
void storeHeapPositionUpdate(StoreEntry *, SwapDir *)
size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:210
StoreEntry * storeCreateEntry(const char *url, const char *logUrl, const RequestFlags &flags, const HttpRequestMethod &method)
Definition: store.cc:734
void swapOut()
signed_int32_t sfileno
Definition: forward.h:22
void storeConfigure(void)
Definition: store.cc:1247
void setMemStatus(mem_status_t)
Definition: store.cc:1502
void negativeCache()
Definition: store.cc:1295
void complete()
Definition: store.cc:1006
KeyScope
Definition: store_key_md5.h:18
RemovalPolicy * createRemovalPolicy(RemovalPolicySettings *) STUB_RETVAL(nullptr) StoreIoStats store_io_stats
Definition: store.cc:1649
bool checkDeferRead(int fd) const
Definition: store.cc:228
void swapOutFileClose(int how)
bool timestampsSet()
Definition: store.cc:1371
int storeTooManyDiskFilesOpen(void)
Definition: store.cc:864
void hashDelete()
Definition: store.cc:408
int expiresMoreThan(time_t expires, time_t when)
Definition: store.cc:1322
void storeEntryReplaceObject(StoreEntry *, HttpReply *)
virtual void vappendf(const char *, va_list)
Definition: store.cc:796
void storeFsDone(void)
void release(const bool shareable=false)
Definition: store.cc:1122
Store::Disk & disk() const
the disk this entry is [being] cached on; asserts for entries w/o a disk
Definition: store.cc:1882
void hashInsert(const cache_key *)
Definition: store.cc:399
bool memoryCachable()
checkCachable() and can be cached in memory
Definition: store.cc:1253
StoreEntry * storeCreatePureEntry(const char *url, const char *log_url, const HttpRequestMethod &method)
Definition: store.cc:716
virtual void append(char const *, int)
Appends a c-string to existing packed data.
Definition: store.cc:778
void trimMemory(const bool preserveSwappable)
Definition: store.cc:1776
void setNoDelay(bool const)
Definition: store.cc:234
RemovalPolicy * REMOVALPOLICYCREATE(wordlist *args)
Definition: RemovalPolicy.h:80
void registerAbortCallback(const AsyncCall::Pointer &)
notify the StoreEntry writer of a 3rd-party initiated StoreEntry abort
Definition: store.cc:1459
bool modifiedSince(const time_t ims, const int imslen=-1) const
Definition: store.cc:1798
#define false
Definition: GnuRegex.c:233
size_t HttpReply *STUB StoreEntry * storeGetPublic(const char *, const HttpRequestMethod &) STUB_RETVAL(nullptr) StoreEntry *storeGetPublicByRequest(HttpRequest *
Definition: store.cc:479
const char * pingStatusStr[]
Definition: stub_store.cc:16
bool hasIfMatchEtag(const HttpRequest &request) const
has ETag matching at least one of the If-Match etags
Definition: store.cc:1835
const char * getMD5Text() const
Definition: store.cc:204
size_t storeEntryInUse() STUB_RETVAL(0) void storeEntryReplaceObject(StoreEntry *

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors