stub_store.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2020 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 fd) const STUB_RETVAL(false)
26 const char *StoreEntry::getMD5Text() const STUB_RETVAL(NULL)
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 &length) const STUB_RETVAL(NULL)
35 void StoreEntry::replaceHttpReply(const HttpReplyPointer &, bool andStartWriting) STUB
37 void StoreEntry::trimMemory(const bool preserveSwappable) STUB
38 void StoreEntry::abort() STUB
39 bool StoreEntry::makePublic(const KeyScope scope) STUB
40 void StoreEntry::makePrivate(const bool shareable) STUB
41 bool StoreEntry::setPublicKey(const KeyScope scope) STUB
42 void StoreEntry::setPrivateKey(const bool, const bool) STUB
44 void StoreEntry::releaseRequest(const bool shareable) STUB
47 void StoreEntry::swapOut() STUB
48 void StoreEntry::swapOutFileClose(int how) STUB
49 const char *StoreEntry::url() const STUB_RETVAL(NULL)
52 int StoreEntry::validToSend() const STUB_RETVAL(0)
55 void StoreEntry::createMemObject(const char *, const char *, const HttpRequestMethod &aMethod) STUB
56 void StoreEntry::ensureMemObject(const char *, const char *, const HttpRequestMethod &) STUB
57 void StoreEntry::dump(int debug_lvl) 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::delayAwareRead(const Comm::ConnectionPointer&, char *buf, int len, AsyncCall::Pointer callback) STUB
68 void StoreEntry::setNoDelay (bool const) STUB
69 bool StoreEntry::modifiedSince(const time_t, const int) const STUB_RETVAL(false)
72 Store::Disk &StoreEntry::disk() const STUB_RETREF(Store::Disk)
76 void StoreEntry::getPublic(StoreClient * aClient, const char *uri, const HttpRequestMethod& method) STUB
77 void *StoreEntry::operator new(size_t byteCount)
78 {
79  STUB
80  return new StoreEntry();
81 }
82 void StoreEntry::operator delete(void *address) STUB
83 //#if USE_SQUID_ESI
84 //ESIElement::Pointer StoreEntry::cachedESITree STUB_RETVAL(NULL)
85 //#endif
87 void StoreEntry::flush() STUB
88 int StoreEntry::unlock(const char *) STUB_RETVAL(0)
89 void StoreEntry::lock(const char *) STUB
90 void StoreEntry::touch() STUB
91 void StoreEntry::release(const bool shareable) STUB
92 void StoreEntry::append(char const *, int) STUB
93 void StoreEntry::vappendf(const char *, va_list) STUB
94 void StoreEntry::setCollapsingRequirement(const bool required) STUB
95 
96 void Store::Maintain(void *unused) STUB
97 
98 std::ostream &operator <<(std::ostream &os, const StoreEntry &)
99 {
100  STUB
101  return os;
102 }
103 
104 size_t storeEntryInUse() STUB_RETVAL(0)
109 StoreEntry *storeCreateEntry(const char *, const char *, const RequestFlags &, const HttpRequestMethod&) STUB_RETVAL(NULL)
110 StoreEntry *storeCreatePureEntry(const char *storeId, const char *logUrl, const HttpRequestMethod&) STUB_RETVAL(nullptr)
111 void storeConfigure(void) STUB
112 int expiresMoreThan(time_t, time_t) STUB_RETVAL(0)
113 void storeAppendPrintf(StoreEntry *, const char *,...) STUB
114 void storeAppendVPrintf(StoreEntry *, const char *, va_list ap) STUB
118 void storeFsInit(void) STUB
119 void storeFsDone(void) STUB
120 void storeReplAdd(const char *, REMOVALPOLICYCREATE *) STUB
121 void destroyStoreEntry(void *) STUB
122 void storeGetMemSpace(int size) STUB
123 
void makePrivate(const bool shareable)
Definition: store.cc:172
void Maintain(void *unused)
Definition: store.cc:1182
virtual void buffer()
Definition: store.cc:1657
int checkTooSmall()
Definition: store.cc:948
store_client_t storeClientType() const
Definition: store.cc:287
void storeReplAdd(const char *type, REMOVALPOLICYCREATE *create)
Definition: store.cc:1701
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:1645
void unregisterAbortCallback(const char *reason)
Definition: store.cc:1545
void releaseRequest(const bool shareable=false)
Definition: store.cc:472
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod const KeyScope scope const char const RequestFlags const HttpRequestMethod const char * logUrl
Definition: stub_store.cc:110
manages a single cache_dir
Definition: Disk.h:21
unsigned char cache_key
Store key.
Definition: forward.h:29
bool makePublic(const KeyScope keyScope=ksDefault)
Definition: store.cc:165
StoreEntry()
Definition: store.cc:350
virtual void flush()
Definition: store.cc:1668
size_t HttpReply *STUB StoreEntry * storeGetPublic(const char *uri, const HttpRequestMethod &method) STUB_RETVAL(NULL) StoreEntry *storeGetPublicByRequest(HttpRequest *request
Definition: store.cc:542
const char * swapStatusStr[]
Definition: stub_store.cc:18
const char * url() const
Definition: store.cc:1622
void createMemObject()
Definition: store.cc:1631
static void getPublicByRequest(StoreClient *aClient, HttpRequest *request)
Definition: store.cc:528
void storeAppendPrintf(StoreEntry *e, const char *fmt,...)
Definition: store.cc:901
void lock(const char *context)
Definition: store.cc:459
void touch()
update last reference timestamp and related Store metadata
Definition: store.cc:466
void setPrivateKey(const bool shareable, const bool permanent)
Definition: store.cc:586
bool setPublicKey(const KeyScope keyScope=ksDefault)
Definition: store.cc:613
const char * memStatusStr[]
Definition: stub_store.cc:17
Abstraction layer for TCP, UDP, TLS, UDS and filedescriptor sockets.
Definition: AcceptLimiter.h:16
void storeGetMemSpace(int size)
Definition: store.cc:1168
bool isAccepting() const
Definition: store.cc:2050
void replaceHttpReply(const HttpReplyPointer &, const bool andStartWriting=true)
Definition: store.cc:1782
const char * storeStatusStr[]
Definition: stub_store.cc:15
static const char * storeId(const int i)
Definition: testRock.cc:180
void storeFsInit(void)
Definition: store.cc:1692
void reset()
Definition: store.cc:1677
StoreEntry * storeGetPublicByRequest(HttpRequest *req, const KeyScope keyScope)
Definition: store.cc:554
bool mayStartSwapOut()
whether we may start writing to disk (now or in the future)
void destroyMemObject()
Definition: store.cc:398
static void getPublic(StoreClient *aClient, const char *uri, const HttpRequestMethod &method)
Definition: store.cc:535
StoreIoStats store_io_stats
Definition: store_io.cc:16
StoreEntry * storeGetPublicByRequestMethod(HttpRequest *req, const HttpRequestMethod &method, const KeyScope keyScope)
Definition: store.cc:548
const char * getSerialisedMetaData(size_t &length) const
Definition: store.cc:1829
Definition: Range.h:18
enum _mem_status_t mem_status_t
int validToSend() const
Definition: store.cc:1409
A StoreEntry::getPublic*() caller.
Definition: StoreClient.h:24
int size
Definition: ModDevPoll.cc:77
@ STORE_NON_CLIENT
Definition: enums.h:72
#define NULL
Definition: types.h:166
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod const KeyScope scope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void SwapDir *STUB void storeSwapFileNumberSet(StoreEntry *e, sfileno filn) STUB void storeFsInit(void) STUB void storeFsDone(void) STUB void storeReplAdd(const char *
bool hasIfNoneMatchEtag(const HttpRequest &request) const
has ETag matching at least one of the If-None-Match etags
Definition: store.cc:1941
void abort()
Definition: store.cc:1124
store_client_t
Definition: enums.h:71
RemovalPolicy * createRemovalPolicy(RemovalPolicySettings *settings) STUB_RETVAL(NULL) StoreIoStats store_io_stats
Definition: store.cc:1727
void setCollapsingRequirement(const bool required)
allow or forbid collapsed requests feeding
Definition: store.cc:2074
int unlock(const char *context)
Definition: store.cc:483
void expireNow()
Definition: store.cc:817
#define STUB_RETREF(x)
Definition: STUB.h:51
static size_t inUseCount()
Definition: store.cc:197
FREE destroyStoreEntry
int checkNegativeHit() const
Definition: store.cc:1352
void write(StoreIOBuffer)
Definition: store.cc:824
bool checkCachable()
Definition: store.cc:976
#define STUB
macro to stub a void function.
Definition: STUB.h:33
bool cacheNegatively()
Definition: store.cc:186
Store statistics related to low-level I/O.
Definition: StoreStats.h:57
void dump(int debug_lvl) const
Definition: store.cc:1555
void storeHeapPositionUpdate(StoreEntry *, SwapDir *)
size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:249
StoreEntry * storeCreateEntry(const char *url, const char *logUrl, const RequestFlags &flags, const HttpRequestMethod &method)
Definition: store.cc:803
void swapOut()
signed_int32_t sfileno
Definition: forward.h:22
void storeConfigure(void)
Definition: store.cc:1325
void setMemStatus(mem_status_t)
Definition: store.cc:1580
RefCount< Comm::Connection > ConnectionPointer
Definition: forward.h:25
void negativeCache()
Definition: store.cc:1373
void complete()
Definition: store.cc:1078
static void getPublicByRequestMethod(StoreClient *aClient, HttpRequest *request, const HttpRequestMethod &method)
Definition: store.cc:521
KeyScope
Definition: store_key_md5.h:18
bool checkDeferRead(int fd) const
Definition: store.cc:267
void swapOutFileClose(int how)
size_t HttpReply *STUB StoreEntry const KeyScope scope STUB_RETVAL(NULL) StoreEntry *storeGetPublicByRequestMethod(HttpRequest *request
bool timestampsSet()
Definition: store.cc:1449
int storeTooManyDiskFilesOpen(void)
Definition: store.cc:936
void hashDelete()
Definition: store.cc:447
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod const KeyScope scope const char const RequestFlags const HttpRequestMethod const char const HttpRequestMethod time_t const char STUB void storeAppendVPrintf(StoreEntry *, const char *, va_list ap) STUB int storeTooManyDiskFilesOpen(void) STUB_RETVAL(0) void storeHeapPositionUpdate(StoreEntry *
Definition: store.cc:911
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod & method
Definition: stub_store.cc:108
int expiresMoreThan(time_t expires, time_t when)
Definition: store.cc:1400
void delayAwareRead(const Comm::ConnectionPointer &conn, char *buf, int len, AsyncCall::Pointer callback)
Definition: store.cc:223
void const char HLPCB * callback
Definition: stub_helper.cc:16
void storeEntryReplaceObject(StoreEntry *, HttpReply *)
virtual void vappendf(const char *, va_list)
Definition: store.cc:867
void storeFsDone(void)
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
void release(const bool shareable=false)
Definition: store.cc:1196
Store::Disk & disk() const
the disk this entry is [being] cached on; asserts for entries w/o a disk
Definition: store.cc:1981
void hashInsert(const cache_key *)
Definition: store.cc:438
bool memoryCachable()
checkCachable() and can be cached in memory
Definition: store.cc:1331
StoreEntry * storeCreatePureEntry(const char *url, const char *log_url, const HttpRequestMethod &method)
Definition: store.cc:785
virtual void append(char const *, int)
Appends a c-string to existing packed data.
Definition: store.cc:849
void trimMemory(const bool preserveSwappable)
Definition: store.cc:1875
void setNoDelay(bool const)
Definition: store.cc:273
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:1537
bool modifiedSince(const time_t ims, const int imslen=-1) const
Definition: store.cc:1897
#define false
Definition: GnuRegex.c:233
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:1934
struct _request * request(char *urlin)
Definition: tcp-banger2.c:291
const char * getMD5Text() const
Definition: store.cc:205
void const char * buf
Definition: stub_helper.cc:16
size_t storeEntryInUse() STUB_RETVAL(0) void storeEntryReplaceObject(StoreEntry *

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors