StoreClient Class Reference

a storeGetPublic*() caller More...

#include <StoreClient.h>

Inheritance diagram for StoreClient:

Collaboration diagram for StoreClient:

Public Member Functions
	~StoreClient () override
virtual LogTags *	loggingTags () const =0
virtual void	fillChecklist (ACLFilledChecklist &) const =0
	configure the given checklist (to reflect the current transaction state) More...

Protected Member Functions
bool	startCollapsingOn (const StoreEntry &, const bool doingRevalidation) const
bool	mayInitiateCollapsing () const
	whether Squid configuration allows us to become a CF initiator More...
bool	onCollapsingPath () const
	whether Squid configuration allows collapsing for this transaction More...

Protected Attributes
bool	didCollapse = false
	whether startCollapsingOn() was called and returned true More...

Detailed Description

Definition at line 40 of file StoreClient.h.

Constructor & Destructor Documentation

~StoreClient()

StoreClient::~StoreClient ( )

inlineoverride

Definition at line 44 of file StoreClient.h.

Member Function Documentation

fillChecklist()

virtual void Acl::ChecklistFiller::fillChecklist ( ACLFilledChecklist &  ) const

pure virtualinherited

Implemented in ConnStateData, htcpSpecifier, clientReplyContext, ICPState, Security::PeerConnector, Ssl::IcapPeerConnector, MimeIcon, and UrnState.

Referenced by onCollapsingPath(), and Security::KeyLogger::shouldLog().

loggingTags()

virtual LogTags* StoreClient::loggingTags ( ) const

pure virtual

Returns

LogTags (if the class logs transactions) or nil (otherwise)

Implemented in htcpSpecifier, ICPState, clientReplyContext, MimeIcon, and UrnState.

Referenced by startCollapsingOn().

mayInitiateCollapsing()

bool StoreClient::mayInitiateCollapsing ( ) const

inlineprotected

Definition at line 59 of file StoreClient.h.

References onCollapsingPath().

Referenced by clientReplyContext::createStoreEntry(), and clientReplyContext::processExpired().

onCollapsingPath()

bool StoreClient::onCollapsingPath ( ) const

protected

Definition at line 52 of file store_client.cc.

References SquidConfig::accessList, Acl::Answer::allowed(), SquidConfig::collapsed_forwarding, SquidConfig::collapsedForwardingAccess, Config, ACLChecklist::fastCheck(), Acl::ChecklistFiller::fillChecklist(), and SquidConfig::onoff.

Referenced by mayInitiateCollapsing(), and startCollapsingOn().

startCollapsingOn()

bool StoreClient::startCollapsingOn ( const StoreEntry &  e, const bool  doingRevalidation  ) const

protected

Returns

whether the caller must collapse on the given entry Before returning true, updates common collapsing-related stats. See also: StoreEntry::hittingRequiresCollapsing().

Definition at line 66 of file store_client.cc.

References debugs, didCollapse, StoreEntry::hittingRequiresCollapsing(), loggingTags(), and onCollapsingPath().

Referenced by htcpSpecifier::checkHit(), ICPState::confirmAndPrepHit(), clientReplyContext::identifyFoundObject(), clientReplyContext::processExpired(), and UrnState::start().

Member Data Documentation

didCollapse

bool StoreClient::didCollapse = false

mutableprotected

Definition at line 64 of file StoreClient.h.

Referenced by clientReplyContext::cacheHit(), htcpSpecifier::checkHit(), ICPState::confirmAndPrepHit(), and startCollapsingOn().

---

The documentation for this class was generated from the following files:

• src/StoreClient.h
• src/store_client.cc