#include <client_side_reply.h>

Inheritance diagram for clientReplyContext:

[legend]

Collaboration diagram for clientReplyContext:

[legend]

Classes
struct	Flags

Public Member Functions
void *	operator new (size_t size)

void	operator delete (void *address)

void *	toCbdata () noexcept

	clientReplyContext (ClientHttpRequest *)

	~clientReplyContext () override

void	saveState ()

void	restoreState ()

void	purgeRequest ()

void	sendClientUpstreamResponse ()

void	doGetMoreData ()

void	identifyStoreObject ()

void	identifyFoundObject (StoreEntry entry, const char detail)

int	storeOKTransferDone () const

int	storeNotOKTransferDone () const

void	setReplyToStoreEntry (StoreEntry e, const char reason)
	replaces current response store entry with the given one More...

void	setReplyToError (err_type, Http::StatusCode, char const , const ConnStateData , HttpRequest , const char , Auth::UserRequest::Pointer)
	builds error using clientBuildError() and calls setReplyToError() below More...

void	setReplyToError (const HttpRequestMethod &method, ErrorState *err)
	creates a store entry for the reply and appends err to it More...

void	setReplyToReply (HttpReply *reply)
	creates a store entry for the reply and appends error reply to it More...

void	createStoreEntry (const HttpRequestMethod &m, RequestFlags flags)

void	removeStoreReference (store_client scp, StoreEntry ep)

void	removeClientStoreReference (store_client *scp, ClientHttpRequest http)

void	startError (ErrorState *err)

void	processExpired ()

clientStream_status_t	replyStatus ()

void	processMiss ()

void	traceReply (clientStreamNode *node)

const char *	storeId () const

LogTags *	loggingTags () const override

Public Attributes
Http::StatusCode	purgeStatus

ClientHttpRequest *	http

int	headers_sz

store_client *	sc

size_t	reqsize

size_t	reqofs

char	tempbuf [HTTP_REQBUF_SZ]
	a temporary buffer if we need working storage More...

struct clientReplyContext::Flags	flags

clientStreamNode *	ourNode

Static Public Attributes
static STCB	CacheHit

static STCB	HandleIMSReply

static STCB	SendMoreData

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...

Private Types
enum	CollapsedRevalidation { crNone = 0 , crInitiator , crSlave }

Private Member Functions
void	fillChecklist (ACLFilledChecklist &) const override
	configure the given checklist (to reflect the current transaction state) More...

clientStreamNode *	getNextNode () const

void	makeThisHead ()

bool	errorInStream (StoreIOBuffer const &result, size_t const &sizeToProcess) const

void	sendStreamError (StoreIOBuffer const &result)

void	pushStreamData (StoreIOBuffer const &result, char *source)

clientStreamNode *	next () const

void	processReplyAccess ()

void	processReplyAccessResult (const Acl::Answer &accessAllowed)

void	cloneReply ()

void	buildReplyHeader ()

bool	alwaysAllowResponse (Http::StatusCode sline) const

int	checkTransferDone ()

void	processOnlyIfCachedMiss ()

bool	processConditional ()
	process conditional request from client More...

void	cacheHit (StoreIOBuffer result)

void	handleIMSReply (StoreIOBuffer result)

void	sendMoreData (StoreIOBuffer result)

void	triggerInitialStoreRead ()

void	sendClientOldEntry ()

void	purgeAllCached ()

bool	purgeEntry (StoreEntry &, const Http::MethodType, const char *descriptionPrefix="")

void	purgeDoPurge ()
	releases both cached GET and HEAD entries More...

void	forgetHit ()

bool	blockedHit () const
	whether squid.conf send_hit prevents us from serving this hit More...

const char *	storeLookupString (bool found) const

void	detailStoreLookup (const char *detail)
	remembers the very first Store lookup classification, ignoring the rest More...

void	sendBodyTooLargeError ()

void	sendPreconditionFailedError ()
	send 412 (Precondition Failed) to client More...

void	sendNotModified ()
	send 304 (Not Modified) to client More...

void	sendNotModifiedOrPreconditionFailedError ()

Private Attributes
HttpReply *	reply

const char *	firstStoreLookup_ = nullptr

StoreEntry *	old_entry

store_client *	old_sc

time_t	old_lastmod

String	old_etag

size_t	old_reqofs

size_t	old_reqsize

bool	deleting

CollapsedRevalidation	collapsedRevalidation

Static Private Attributes
static cbdata_type	CBDATA_clientReplyContext = CBDATA_UNKNOWN

static ACLCB	ProcessReplyAccessResult

Detailed Description

Definition at line 22 of file client_side_reply.h.

Member Enumeration Documentation

◆ CollapsedRevalidation

enum clientReplyContext::CollapsedRevalidation

private

Enumerator
crNone	collapsed revalidation is not allowed for this context
crInitiator	we initiated collapsed revalidation request
crSlave	we collapsed on the existing revalidation request

Definition at line 146 of file client_side_reply.h.

Constructor & Destructor Documentation

◆ clientReplyContext()

clientReplyContext::clientReplyContext ( ClientHttpRequest * clientContext )

Definition at line 73 of file client_side_reply.cc.

References tempbuf.

◆ ~clientReplyContext()

clientReplyContext::~clientReplyContext ( )

override

Definition at line 59 of file client_side_reply.cc.

References cbdataReferenceDone, deleting, http, HTTPMSGUNLOCK(), old_entry, old_sc, removeClientStoreReference(), removeStoreReference(), reply, and sc.

Member Function Documentation

◆ alwaysAllowResponse()

bool clientReplyContext::alwaysAllowResponse ( Http::StatusCode sline ) const

private

Definition at line 1219 of file client_side_reply.cc.

References Http::scContinue, Http::scNoContent, Http::scNotModified, Http::scProcessing, and Http::scSwitchingProtocols.

Referenced by processReplyAccess(), and processReplyAccessResult().

◆ blockedHit()

bool clientReplyContext::blockedHit ( ) const

private

Definition at line 867 of file client_side_reply.cc.

References SquidConfig::accessList, clientAclChecklistCreate(), Config, ClientHttpRequest::flags, MemObject::freshestReply(), http, HTTPMSGLOCK(), ClientHttpRequest::Flags::internal, StoreEntry::mem(), SquidConfig::sendHit, and ClientHttpRequest::storeEntry().

Referenced by cacheHit().

◆ buildReplyHeader()

void clientReplyContext::buildReplyHeader ( )

private

Generate the reply headers sent to client.

Filters out unwanted entries and hop-by-hop from original reply header then adds extra entries if we have more info than origin server then adds Squid specific entries

Definition at line 1252 of file client_side_reply.cc.

Referenced by cloneReply().

◆ cacheHit()

void clientReplyContext::cacheHit ( StoreIOBuffer result )

private

Process a possible cache HIT.

Ignore if the HIT object is being deleted.

Definition at line 536 of file client_side_reply.cc.

References assert, blockedHit(), StoreEntry::checkNegativeHit(), clientGetMoreData, SBuf::cmp(), HttpRequest::conditional(), Config, DBG_IMPORTANT, debugs, deleting, EBIT_TEST, ENTRY_ABORTED, StoreIOBuffer::error, ClientHttpRequest::flags, HttpRequest::flags, StoreEntry::flags, StoreIOBuffer::flags, AnyP::Uri::getScheme(), http, IN_MEMORY, ClientHttpRequest::Flags::internal, StoreEntry::lastModified(), StoreIOBuffer::length, LOG_TCP_CLIENT_REFRESH_MISS, LOG_TCP_HIT, LOG_TCP_MEM_HIT, LOG_TCP_MISS, LOG_TCP_NEGATIVE_HIT, LOG_TCP_OFFLINE_HIT, LOG_TCP_SWAPFAIL_MISS, ClientHttpRequest::loggingTags(), StoreEntry::mayStartHitting(), StoreEntry::mem_obj, StoreEntry::mem_status, HttpRequest::method, Http::METHOD_PURGE, RequestFlags::needValidation, RequestFlags::noCache, RequestFlags::noCacheHack(), SquidConfig::offline, LogTags::oldType, SquidConfig::onoff, ourNode, processConditional(), processExpired(), processMiss(), AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, purgeRequest(), refreshCheckHTTP(), removeClientStoreReference(), reqofs, reqsize, ClientHttpRequest::request, sc, sendMoreData(), STORE_OK, StoreEntry::store_status, ClientHttpRequest::storeEntry(), HttpRequest::storeId(), MemObject::storeId(), ClientHttpRequest::updateLoggingTags(), ClientHttpRequest::uri, HttpRequest::url, VARY_CANCEL, VARY_MATCH, VARY_NONE, VARY_OTHER, and varyEvaluateMatch().

◆ checkTransferDone()

int clientReplyContext::checkTransferDone ( )

private

Definition at line 1043 of file client_side_reply.cc.

References RequestFlags::chunkedReply, clientReplyContext::Flags::complete, ClientHttpRequest::Flags::done_copying, flags, ClientHttpRequest::flags, HttpRequest::flags, http, ClientHttpRequest::request, STORE_OK, StoreEntry::store_status, ClientHttpRequest::storeEntry(), storeNotOKTransferDone(), and storeOKTransferDone().

Referenced by replyStatus().

◆ cloneReply()

void clientReplyContext::cloneReply ( )

private

Definition at line 1488 of file client_side_reply.cc.

References ClientHttpRequest::al, assert, buildReplyHeader(), HttpReply::clone(), MemObject::freshestReply(), http, HTTPMSGLOCK(), StoreEntry::mem(), AnyP::PROTO_HTTP, AnyP::ProtocolVersion::protocol, Http::ProtocolVersion(), AccessLogEntry::reply, reply, HttpReply::sline, ClientHttpRequest::storeEntry(), and Http::StatusLine::version.

Referenced by sendMoreData().

◆ createStoreEntry()

void clientReplyContext::createStoreEntry	(	const HttpRequestMethod &	m,
		RequestFlags	flags
	)

◆ detailStoreLookup()

void clientReplyContext::detailStoreLookup ( const char * detail )

private

Definition at line 1623 of file client_side_reply.cc.

References debugs, and firstStoreLookup_.

Referenced by identifyFoundObject(), and purgeDoPurge().

◆ doGetMoreData()

void clientReplyContext::doGetMoreData ( )

◆ errorInStream()

bool clientReplyContext::errorInStream	(	StoreIOBuffer const &	result,
		size_t const &	sizeToProcess
	)		const

private

Definition at line 1763 of file client_side_reply.cc.

References EBIT_TEST, ENTRY_ABORTED, StoreIOBuffer::error, StoreEntry::flags, StoreIOBuffer::flags, http, and ClientHttpRequest::storeEntry().

Referenced by sendMoreData().

◆ fillChecklist()

void clientReplyContext::fillChecklist ( ACLFilledChecklist & ) const

overrideprivatevirtual

Implements Acl::ChecklistFiller.

Definition at line 2107 of file client_side_reply.cc.

References clientAclChecklistFill(), and http.

◆ forgetHit()

void clientReplyContext::forgetHit ( )

private

Safely disposes of an entry pointing to a cache hit that we do not want. We cannot just ignore the entry because it may be locking or otherwise holding an associated cache resource of some sort.

Definition at line 1510 of file client_side_reply.cc.

References assert, http, StoreEntry::lock(), ClientHttpRequest::storeEntry(), and StoreEntry::unlock().

Referenced by identifyFoundObject().

◆ getNextNode()

clientStreamNode * clientReplyContext::getNextNode ( ) const

private

Definition at line 243 of file client_side_reply.cc.

References dlink_node::data, dlink_node::next, clientStreamNode::node, and ourNode.

Referenced by doGetMoreData(), and next().

◆ handleIMSReply()

void clientReplyContext::handleIMSReply ( StoreIOBuffer result )

private

Definition at line 419 of file client_side_reply.cc.

References ClientHttpRequest::al, AccessLogEntry::cache, AccessLogEntry::CacheDetails::code, collapsedRevalidation, crSlave, debugs, deleting, EBIT_TEST, ENTRY_ABORTED, LogTags::err, StoreIOBuffer::error, RequestFlags::failOnValidationError, HttpRequest::flags, StoreEntry::flags, StoreIOBuffer::flags, MemObject::freshestReply(), http, LogTagsErrors::ignored, HttpRequest::ims, RequestFlags::ims, HttpRequest::imslen, StoreIOBuffer::length, LOG_TCP_MISS, LOG_TCP_REFRESH_FAIL_ERR, LOG_TCP_REFRESH_FAIL_OLD, LOG_TCP_REFRESH_MODIFIED, LOG_TCP_REFRESH_UNMODIFIED, StoreEntry::mayStartHitting(), StoreEntry::mem(), StoreEntry::modifiedSince(), old_entry, processMiss(), reqofs, reqsize, ClientHttpRequest::request, restoreState(), Store::Root(), Http::scInternalServerError, Http::scNone, Http::scNotModified, sendClientOldEntry(), sendClientUpstreamResponse(), HttpReply::sline, RequestFlags::staleIfHit, Http::StatusLine::status(), ClientHttpRequest::storeEntry(), ClientHttpRequest::updateLoggingTags(), Store::Controller::updateOnNotModified(), and StoreEntry::url().

◆ identifyFoundObject()

void clientReplyContext::identifyFoundObject	(	StoreEntry *	newEntry,
		const char *	detail
	)

Check state of the current StoreEntry object. to see if we can determine the final status of the request.

If the request has no-cache flag set or some no_cache HACK in operation we 'invalidate' the cached IP entries for this request ???

If no StoreEntry object is current assume this object isn't in the cache set MISS

If we are running in offline mode set to HIT

If redirection status is True force this to be a MISS

Definition at line 1544 of file client_side_reply.cc.

References Config, debugs, detailStoreLookup(), doGetMoreData(), EBIT_TEST, ENTRY_SPECIAL, HttpRequest::flags, forgetHit(), AnyP::Uri::host(), http, ipcacheInvalidateNegative(), LOG_TCP_CLIENT_REFRESH_MISS, LOG_TCP_HIT, LOG_TCP_MISS, LOG_TCP_REDIRECT, RequestFlags::noCache, RequestFlags::noCacheHack(), SquidConfig::offline, SquidConfig::onoff, ClientHttpRequest::redirect, ClientHttpRequest::request, StoreClient::startCollapsingOn(), ClientHttpRequest::Redirect::status, ClientHttpRequest::storeEntry(), ClientHttpRequest::updateLoggingTags(), and HttpRequest::url.

Referenced by identifyStoreObject().

◆ identifyStoreObject()

void clientReplyContext::identifyStoreObject ( )

Definition at line 1524 of file client_side_reply.cc.

References HttpRequest::flags, http, identifyFoundObject(), RequestFlags::internal, RequestFlags::noCache, ClientHttpRequest::request, storeGetPublicByRequest(), and storeLookupString().

Referenced by clientGetMoreData().

◆ loggingTags()

LogTags * clientReplyContext::loggingTags ( ) const

overridevirtual

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

Implements StoreClient.

Definition at line 916 of file client_side_reply.cc.

References ClientHttpRequest::al, AccessLogEntry::cache, AccessLogEntry::CacheDetails::code, and http.

◆ makeThisHead()

void clientReplyContext::makeThisHead ( )

private

Definition at line 1755 of file client_side_reply.cc.

References ClientHttpRequest::active, ClientActiveRequests, dlinkAdd(), dlinkDelete(), and http.

Referenced by sendMoreData().

◆ mayInitiateCollapsing()

bool StoreClient::mayInitiateCollapsing ( ) const

inlineprotectedinherited

Definition at line 45 of file StoreClient.h.

References StoreClient::onCollapsingPath().

Referenced by createStoreEntry(), and processExpired().

◆ next()

clientStreamNode * clientReplyContext::next ( ) const

private

Definition at line 1810 of file client_side_reply.cc.

References assert, ClientHttpRequest::client_stream, dlink_node::data, getNextNode(), dlink_list::head, http, and dlink_node::next.

Referenced by processReplyAccessResult(), pushStreamData(), sendClientOldEntry(), sendMoreData(), and triggerInitialStoreRead().

◆ onCollapsingPath()

bool StoreClient::onCollapsingPath ( ) const

protectedinherited

Definition at line 50 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 StoreClient::mayInitiateCollapsing(), and StoreClient::startCollapsingOn().

◆ operator delete()

void clientReplyContext::operator delete ( void * address )

inline

Definition at line 24 of file client_side_reply.h.

◆ operator new()

void * clientReplyContext::operator new ( size_t size )

inline

Definition at line 24 of file client_side_reply.h.

◆ processConditional()

bool clientReplyContext::processConditional ( )

private

◆ processExpired()

void clientReplyContext::processExpired ( )

Definition at line 266 of file client_side_reply.cc.

Referenced by cacheHit().

◆ processMiss()

void clientReplyContext::processMiss ( )

Prepare to fetch the object as it's a cache miss of some kind.

We might have a left-over StoreEntry from a failed cache hit or IMS request.

Check if its a PURGE request to be actioned.

Check if its an 'OTHER' request. Purge all cached entries if so and continue.

Check if 'only-if-cached' flag is set. Action if so.

Deny loops

Start forwarding to get the new object from network

Definition at line 725 of file client_side_reply.cc.

Referenced by cacheHit(), doGetMoreData(), handleIMSReply(), and processConditional().

◆ processOnlyIfCachedMiss()

void clientReplyContext::processOnlyIfCachedMiss ( )

private

client issued a request with an only-if-cached cache-control directive; we did not find a cached object that can be returned without contacting other servers; respond with a 504 (Gateway Timeout) as suggested in [RFC 2068]

Definition at line 801 of file client_side_reply.cc.

References ClientHttpRequest::al, clientBuildError(), AccessLogEntry::HttpDetails::code, debugs, ERR_ONLY_IF_CACHED_MISS, ClientHttpRequest::getConn(), AccessLogEntry::http, http, HttpRequest::method, removeClientStoreReference(), ClientHttpRequest::request, sc, Http::scGatewayTimeout, startError(), and ClientHttpRequest::uri.

Referenced by processExpired(), and processMiss().

◆ processReplyAccess()

void clientReplyContext::processReplyAccess ( )

private

Don't block our own responses or HTTP status messages

Check for reply to big error

check for absent access controls (permit by default)

Process http_reply_access lists

Definition at line 1884 of file client_side_reply.cc.

References ACCESS_ALLOWED, SquidConfig::accessList, alwaysAllowResponse(), assert, clientAclChecklistCreate(), Config, HttpReply::expectedBodyTooLarge(), Http::Message::hdr_sz, headers_sz, http, HTTPMSGLOCK(), LOG_TCP_DENIED, LOG_TCP_DENIED_REPLY, ClientHttpRequest::loggingTags(), ACLChecklist::nonBlockingCheck(), LogTags::oldType, ProcessReplyAccessResult, processReplyAccessResult(), ACLFilledChecklist::reply, reply, SquidConfig::reply, ClientHttpRequest::request, sendBodyTooLargeError(), HttpReply::sline, and Http::StatusLine::status().

Referenced by sendMoreData().

◆ processReplyAccessResult()

void clientReplyContext::processReplyAccessResult ( const Acl::Answer & accessAllowed )

private

Definition at line 1928 of file client_side_reply.cc.

Referenced by processReplyAccess().

◆ purgeAllCached()

void clientReplyContext::purgeAllCached ( )

private

Definition at line 908 of file client_side_reply.cc.

References SBuf::c_str(), HttpRequest::effectiveRequestUri(), http, purgeEntriesByUrl(), and ClientHttpRequest::request.

Referenced by processMiss().

◆ purgeDoPurge()

void clientReplyContext::purgeDoPurge ( )

private

◆ purgeEntry()

bool clientReplyContext::purgeEntry	(	StoreEntry &	entry,
		const Http::MethodType	methodType,
		const char *	descriptionPrefix = `""`
	)

private

attempts to release the cached entry

Returns: whether the entry was released

Definition at line 1009 of file client_side_reply.cc.

References debugs, HTCP_CLR_PURGE, http, Http::MethodStr(), neighborsHtcpClear(), purgeStatus, StoreEntry::release(), ClientHttpRequest::request, Http::scOkay, and StoreEntry::url().

Referenced by purgeDoPurge().

◆ purgeRequest()

void clientReplyContext::purgeRequest ( )

Definition at line 925 of file client_side_reply.cc.

References ClientHttpRequest::al, clientBuildError(), Config2, debugs, SquidConfig2::enable_purge, ERR_ACCESS_DENIED, ClientHttpRequest::getConn(), AnyP::Uri::host(), http, ipcacheInvalidate(), LOG_TCP_DENIED, SquidConfig2::onoff, purgeDoPurge(), ClientHttpRequest::request, Http::scForbidden, startError(), ClientHttpRequest::updateLoggingTags(), and HttpRequest::url.

Referenced by cacheHit(), clientGetMoreData(), and processMiss().

◆ pushStreamData()

void clientReplyContext::pushStreamData	(	StoreIOBuffer const &	result,
		char *	source
	)

private

Definition at line 1789 of file client_side_reply.cc.

References assert, ClientHttpRequest::client_stream, clientStreamCallback(), clientReplyContext::Flags::complete, dlink_node::data, StoreIOBuffer::data, debugs, flags, dlink_list::head, headers_sz, http, StoreIOBuffer::length, next(), and StoreIOBuffer::offset.

Referenced by sendMoreData().

◆ removeClientStoreReference()

void clientReplyContext::removeClientStoreReference	(	store_client **	scp,
		ClientHttpRequest *	http
	)

Definition at line 188 of file client_side_reply.cc.

References removeStoreReference(), and ClientHttpRequest::storeEntry().

Referenced by ~clientReplyContext(), cacheHit(), processMiss(), processOnlyIfCachedMiss(), processReplyAccessResult(), restoreState(), sendBodyTooLargeError(), sendNotModified(), and sendPreconditionFailedError().

◆ removeStoreReference()

void clientReplyContext::removeStoreReference	(	store_client **	scp,
		StoreEntry **	ep
	)

Definition at line 173 of file client_side_reply.cc.

References storeUnregister(), and StoreEntry::unlock().

Referenced by ~clientReplyContext(), removeClientStoreReference(), and sendClientUpstreamResponse().

◆ replyStatus()

clientStream_status_t clientReplyContext::replyStatus ( )

◆ restoreState()

void clientReplyContext::restoreState ( )

Definition at line 214 of file client_side_reply.cc.

References assert, String::clean(), debugs, HttpRequest::etag, http, HttpRequest::lastmod, old_entry, old_etag, old_lastmod, old_reqofs, old_reqsize, old_sc, removeClientStoreReference(), reqofs, reqsize, ClientHttpRequest::request, sc, and ClientHttpRequest::storeEntry().

Referenced by handleIMSReply(), and sendClientOldEntry().

◆ saveState()

void clientReplyContext::saveState ( )

Definition at line 196 of file client_side_reply.cc.

References assert, debugs, HttpRequest::etag, http, HttpRequest::lastmod, old_entry, old_etag, old_lastmod, old_reqofs, old_reqsize, old_sc, reqofs, reqsize, ClientHttpRequest::request, sc, and ClientHttpRequest::storeEntry().

Referenced by processExpired().

◆ sendBodyTooLargeError()

void clientReplyContext::sendBodyTooLargeError ( )

private

Definition at line 1817 of file client_side_reply.cc.

References ClientHttpRequest::al, clientBuildError(), ERR_TOO_BIG, ClientHttpRequest::getConn(), http, HTTPMSGUNLOCK(), LOG_TCP_DENIED_REPLY, removeClientStoreReference(), reply, ClientHttpRequest::request, sc, Http::scForbidden, startError(), and ClientHttpRequest::updateLoggingTags().

Referenced by processReplyAccess().

◆ sendClientOldEntry()

void clientReplyContext::sendClientOldEntry ( )

private

Definition at line 400 of file client_side_reply.cc.

References assert, clientStreamNode::data, EBIT_TEST, ENTRY_ABORTED, StoreEntry::flags, http, next(), reqofs, reqsize, restoreState(), sendMoreData(), and ClientHttpRequest::storeEntry().

Referenced by handleIMSReply().

◆ sendClientUpstreamResponse()

void clientReplyContext::sendClientUpstreamResponse ( )

Definition at line 371 of file client_side_reply.cc.

References assert, StoreEntry::clearPublicKeyScope(), collapsedRevalidation, StoreIOBuffer::data, EBIT_TEST, ENTRY_ABORTED, StoreEntry::flags, http, StoreIOBuffer::length, old_entry, old_reqofs, old_reqsize, old_sc, removeStoreReference(), reqofs, reqsize, sendMoreData(), ClientHttpRequest::storeEntry(), and tempbuf.

Referenced by handleIMSReply().

◆ sendMoreData()

void clientReplyContext::sendMoreData ( StoreIOBuffer result )

private

Definition at line 2024 of file client_side_reply.cc.

Referenced by cacheHit(), sendClientOldEntry(), and sendClientUpstreamResponse().

◆ sendNotModified()

void clientReplyContext::sendNotModified ( )

private

◆ sendNotModifiedOrPreconditionFailedError()

void clientReplyContext::sendNotModifiedOrPreconditionFailedError ( )

private

send 304 (Not Modified) or 412 (Precondition Failed) to client depending on request method

Definition at line 1874 of file client_side_reply.cc.

References http, HttpRequest::method, Http::METHOD_GET, Http::METHOD_HEAD, ClientHttpRequest::request, sendNotModified(), and sendPreconditionFailedError().

Referenced by processConditional().

◆ sendPreconditionFailedError()

void clientReplyContext::sendPreconditionFailedError ( )

private

Definition at line 1830 of file client_side_reply.cc.

References ClientHttpRequest::al, clientBuildError(), ERR_PRECONDITION_FAILED, ClientHttpRequest::getConn(), http, HTTPMSGUNLOCK(), LOG_TCP_HIT, removeClientStoreReference(), reply, ClientHttpRequest::request, sc, Http::scPreconditionFailed, startError(), and ClientHttpRequest::updateLoggingTags().

Referenced by processConditional(), and sendNotModifiedOrPreconditionFailedError().

◆ sendStreamError()

void clientReplyContext::sendStreamError ( StoreIOBuffer const & result )

private

call clientWriteComplete so the client socket gets closed

We call into the stream, because we don't know that there is a client socket!

Definition at line 1772 of file client_side_reply.cc.

References ClientHttpRequest::client_stream, clientStreamCallback(), clientReplyContext::Flags::complete, dlink_node::data, debugs, StoreIOBuffer::error, flags, HttpRequest::flags, StoreIOBuffer::flags, dlink_list::head, http, ClientHttpRequest::request, and RequestFlags::streamError.

Referenced by sendMoreData().

◆ setReplyToError() [1/2]

void clientReplyContext::setReplyToError	(	const HttpRequestMethod &	method,
		ErrorState *	err
	)

Definition at line 120 of file client_side_reply.cc.

References ClientHttpRequest::al, assert, ErrorState::callback_data, AccessLogEntry::HttpDetails::code, createStoreEntry(), errorAppendEntry(), HttpRequest::flags, AccessLogEntry::http, http, ErrorState::httpStatus, HttpRequest::ignoreRange(), RequestFlags::proxyKeepalive, ClientHttpRequest::request, Http::scNotImplemented, and ClientHttpRequest::storeEntry().

◆ setReplyToError() [2/2]

void clientReplyContext::setReplyToError	(	err_type	err,
		Http::StatusCode	status,
		char const *	uri,
		const ConnStateData *	conn,
		HttpRequest *	failedrequest,
		const char *	unparsedrequest,
		Auth::UserRequest::Pointer	auth_user_request
	)

Create an error in the store awaiting the client side to read it.

This may be better placed in the clientStream logic, but it has not been relocated there yet

Definition at line 99 of file client_side_reply.cc.

References ClientHttpRequest::al, clientBuildError(), conn, http, HttpRequest::method, Http::METHOD_NONE, setReplyToError(), and xstrdup.

Referenced by ConnStateData::abortChunkedRequestBody(), clientProcessRequest(), Http::One::Server::processParsedRequest(), ConnStateData::serveDelayedError(), Http::One::Server::setReplyError(), and setReplyToError().

◆ setReplyToReply()

void clientReplyContext::setReplyToReply ( HttpReply * reply )

Definition at line 138 of file client_side_reply.cc.

References ClientHttpRequest::al, AccessLogEntry::HttpDetails::code, createStoreEntry(), AccessLogEntry::http, http, HttpRequest::ignoreRange(), HttpRequest::method, Must, ClientHttpRequest::request, HttpReply::sline, Http::StatusLine::status(), ClientHttpRequest::storeEntry(), and StoreEntry::storeErrorResponse().

Referenced by Ftp::Server::earlyError().

◆ setReplyToStoreEntry()

void clientReplyContext::setReplyToStoreEntry	(	StoreEntry *	e,
		const char *	reason
	)

Definition at line 157 of file client_side_reply.cc.

References DelayId::DelayClient(), flags, http, HttpRequest::ignoreRange(), StoreEntry::lock(), reqofs, reqsize, ClientHttpRequest::request, sc, store_client::setDelayId(), storeClientListAdd(), ClientHttpRequest::storeEntry(), and clientReplyContext::Flags::storelogiccomplete.

Referenced by ConnStateData::serveDelayedError().

◆ startCollapsingOn()

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

protectedinherited

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 64 of file store_client.cc.

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

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

◆ startError()

void clientReplyContext::startError ( ErrorState * err )

Definition at line 235 of file client_side_reply.cc.

References createStoreEntry(), errorAppendEntry(), http, HttpRequest::method, ClientHttpRequest::request, ClientHttpRequest::storeEntry(), and triggerInitialStoreRead().

Referenced by processOnlyIfCachedMiss(), processReplyAccessResult(), purgeDoPurge(), purgeRequest(), sendBodyTooLargeError(), and sendPreconditionFailedError().

◆ storeId()

const char * clientReplyContext::storeId ( ) const

inline

Definition at line 64 of file client_side_reply.h.

References http, String::size(), ClientHttpRequest::store_id, String::termedBuf(), and ClientHttpRequest::uri.

Referenced by createStoreEntry(), doGetMoreData(), and processExpired().

◆ storeLookupString()

const char * clientReplyContext::storeLookupString ( bool found ) const

inlineprivate

Definition at line 123 of file client_side_reply.h.

Referenced by identifyStoreObject(), and purgeDoPurge().

◆ storeNotOKTransferDone()

int clientReplyContext::storeNotOKTransferDone ( ) const

Definition at line 1092 of file client_side_reply.cc.

References assert, MemObject::baseReply(), Http::Message::content_length, debugs, headers_sz, ClientHttpRequest::Out::headers_sz, http, StoreEntry::mem_obj, ClientHttpRequest::out, ClientHttpRequest::request, ClientHttpRequest::Out::size, and ClientHttpRequest::storeEntry().

Referenced by checkTransferDone().

◆ storeOKTransferDone()

int clientReplyContext::storeOKTransferDone ( ) const

Definition at line 1076 of file client_side_reply.cc.

References assert, debugs, headers_sz, http, StoreEntry::objectLen(), ClientHttpRequest::Out::offset, ClientHttpRequest::out, and ClientHttpRequest::storeEntry().

Referenced by checkTransferDone().

◆ toCbdata()

void * clientReplyContext::toCbdata ( )

inlinenoexcept

Definition at line 24 of file client_side_reply.h.

◆ traceReply()

void clientReplyContext::traceReply ( clientStreamNode * node )

◆ triggerInitialStoreRead()

void clientReplyContext::triggerInitialStoreRead ( )

private

Definition at line 252 of file client_side_reply.cc.

References assert, clientStreamNode::data, http, next(), reqofs, sc, SendMoreData, storeClientCopy(), and ClientHttpRequest::storeEntry().

Referenced by processMiss(), purgeDoPurge(), sendNotModified(), and startError().

Member Data Documentation

◆ CacheHit

void clientReplyContext::CacheHit

static

clientReplyContext::cacheHit Should only be called until the HTTP reply headers have been parsed. Normally this should be a single call, but it might take more than one. As soon as we have the headers, we hand off to clientSendMoreData, processExpired, or processMiss.

Definition at line 27 of file client_side_reply.h.

Referenced by doGetMoreData().

◆ CBDATA_clientReplyContext

cbdata_type clientReplyContext::CBDATA_clientReplyContext = CBDATA_UNKNOWN

staticprivate

Definition at line 24 of file client_side_reply.h.

◆ collapsedRevalidation

CollapsedRevalidation clientReplyContext::collapsedRevalidation

private

Definition at line 152 of file client_side_reply.h.

Referenced by buildReplyHeader(), handleIMSReply(), processExpired(), and sendClientUpstreamResponse().

◆ deleting

bool clientReplyContext::deleting

private

Definition at line 144 of file client_side_reply.h.

Referenced by ~clientReplyContext(), cacheHit(), handleIMSReply(), and sendMoreData().

◆ firstStoreLookup_

const char* clientReplyContext::firstStoreLookup_ = nullptr

private

Classification of the initial Store lookup. This very first lookup happens without the Vary-driven key augmentation. TODO: Exclude internal Store match bans from the "mismatch" category.

Definition at line 134 of file client_side_reply.h.

Referenced by buildReplyHeader(), and detailStoreLookup().

◆ flags

struct clientReplyContext::Flags clientReplyContext::flags

Referenced by checkTransferDone(), clientGetMoreData(), createStoreEntry(), processReplyAccessResult(), pushStreamData(), replyStatus(), sendMoreData(), sendStreamError(), and setReplyToStoreEntry().

◆ HandleIMSReply

void clientReplyContext::HandleIMSReply

static

Definition at line 28 of file client_side_reply.h.

Referenced by processExpired().

◆ headers_sz

int clientReplyContext::headers_sz

Base reply header bytes received from Store. Compatible with ClientHttpRequest::Out::offset. Not to be confused with ClientHttpRequest::Out::headers_sz.

Definition at line 75 of file client_side_reply.h.

Referenced by clientGetMoreData(), processReplyAccess(), pushStreamData(), storeNotOKTransferDone(), storeOKTransferDone(), and traceReply().

◆ http

ClientHttpRequest* clientReplyContext::http

Definition at line 71 of file client_side_reply.h.

Referenced by ~clientReplyContext(), ConnStateData::abortChunkedRequestBody(), blockedHit(), buildReplyHeader(), cacheHit(), checkTransferDone(), clientGetMoreData(), clientReplyStatus(), cloneReply(), createStoreEntry(), doGetMoreData(), errorInStream(), fillChecklist(), forgetHit(), handleIMSReply(), identifyFoundObject(), identifyStoreObject(), loggingTags(), makeThisHead(), next(), processConditional(), processExpired(), processMiss(), processOnlyIfCachedMiss(), processReplyAccess(), processReplyAccessResult(), purgeAllCached(), purgeDoPurge(), purgeEntry(), purgeRequest(), pushStreamData(), replyStatus(), restoreState(), saveState(), sendBodyTooLargeError(), sendClientOldEntry(), sendClientUpstreamResponse(), sendMoreData(), sendNotModified(), sendNotModifiedOrPreconditionFailedError(), sendPreconditionFailedError(), sendStreamError(), setReplyToError(), setReplyToReply(), setReplyToStoreEntry(), startError(), storeId(), storeNotOKTransferDone(), storeOKTransferDone(), traceReply(), and triggerInitialStoreRead().

◆ old_entry

StoreEntry* clientReplyContext::old_entry

private

Definition at line 137 of file client_side_reply.h.

Referenced by ~clientReplyContext(), handleIMSReply(), processExpired(), restoreState(), saveState(), and sendClientUpstreamResponse().

◆ old_etag

String clientReplyContext::old_etag

private

Definition at line 140 of file client_side_reply.h.

Referenced by restoreState(), and saveState().

◆ old_lastmod

time_t clientReplyContext::old_lastmod

private

Definition at line 139 of file client_side_reply.h.

Referenced by restoreState(), and saveState().

◆ old_reqofs

size_t clientReplyContext::old_reqofs

private

Definition at line 141 of file client_side_reply.h.

Referenced by restoreState(), saveState(), and sendClientUpstreamResponse().

◆ old_reqsize

size_t clientReplyContext::old_reqsize

private

Definition at line 142 of file client_side_reply.h.

Referenced by restoreState(), saveState(), and sendClientUpstreamResponse().

◆ old_sc

store_client* clientReplyContext::old_sc

private

Definition at line 138 of file client_side_reply.h.

Referenced by ~clientReplyContext(), restoreState(), saveState(), and sendClientUpstreamResponse().

◆ ourNode

clientStreamNode* clientReplyContext::ourNode

Definition at line 88 of file client_side_reply.h.

Referenced by cacheHit(), clientGetMoreData(), and getNextNode().

◆ ProcessReplyAccessResult

void clientReplyContext::ProcessReplyAccessResult

staticprivate

Definition at line 102 of file client_side_reply.h.

Referenced by processReplyAccess().

◆ purgeStatus

Http::StatusCode clientReplyContext::purgeStatus

Definition at line 66 of file client_side_reply.h.

Referenced by purgeDoPurge(), and purgeEntry().

◆ reply

HttpReply* clientReplyContext::reply

private

Definition at line 100 of file client_side_reply.h.

Referenced by ~clientReplyContext(), buildReplyHeader(), cloneReply(), processReplyAccess(), processReplyAccessResult(), replyStatus(), sendBodyTooLargeError(), sendMoreData(), and sendPreconditionFailedError().

◆ reqofs

size_t clientReplyContext::reqofs

Definition at line 78 of file client_side_reply.h.

Referenced by cacheHit(), createStoreEntry(), doGetMoreData(), handleIMSReply(), processReplyAccessResult(), restoreState(), saveState(), sendClientOldEntry(), sendClientUpstreamResponse(), sendMoreData(), setReplyToStoreEntry(), and triggerInitialStoreRead().

◆ reqsize

size_t clientReplyContext::reqsize

Definition at line 77 of file client_side_reply.h.

Referenced by cacheHit(), createStoreEntry(), handleIMSReply(), restoreState(), saveState(), sendClientOldEntry(), sendClientUpstreamResponse(), sendMoreData(), and setReplyToStoreEntry().

◆ sc

store_client* clientReplyContext::sc

◆ SendMoreData

void clientReplyContext::SendMoreData

static

Accepts chunk of a http message in buf, parses prefix, filters headers and such, writes processed message to the message recipient

Definition at line 29 of file client_side_reply.h.

Referenced by clientGetMoreData(), traceReply(), and triggerInitialStoreRead().

◆ tempbuf

char clientReplyContext::tempbuf[HTTP_REQBUF_SZ]

Definition at line 79 of file client_side_reply.h.

Referenced by clientReplyContext(), processExpired(), and sendClientUpstreamResponse().

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

src/client_side_reply.h
src/client_side_reply.cc

squid-cache.org

Optimising Web Delivery

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CollapsedRevalidation

Constructor & Destructor Documentation

◆ clientReplyContext()

◆ ~clientReplyContext()

Member Function Documentation

◆ alwaysAllowResponse()

◆ blockedHit()

◆ buildReplyHeader()

◆ cacheHit()

◆ checkTransferDone()

◆ cloneReply()

◆ createStoreEntry()

◆ detailStoreLookup()

◆ doGetMoreData()

◆ errorInStream()

◆ fillChecklist()

◆ forgetHit()

◆ getNextNode()

◆ handleIMSReply()

◆ identifyFoundObject()

◆ identifyStoreObject()

◆ loggingTags()

◆ makeThisHead()

◆ mayInitiateCollapsing()

◆ next()

◆ onCollapsingPath()

◆ operator delete()

◆ operator new()

◆ processConditional()

◆ processExpired()

◆ processMiss()

◆ processOnlyIfCachedMiss()

◆ processReplyAccess()

◆ processReplyAccessResult()

◆ purgeAllCached()

◆ purgeDoPurge()

◆ purgeEntry()

◆ purgeRequest()

◆ pushStreamData()

◆ removeClientStoreReference()

◆ removeStoreReference()

◆ replyStatus()

◆ restoreState()

◆ saveState()

◆ sendBodyTooLargeError()

◆ sendClientOldEntry()

◆ sendClientUpstreamResponse()

◆ sendMoreData()

◆ sendNotModified()

◆ sendNotModifiedOrPreconditionFailedError()

◆ sendPreconditionFailedError()

◆ sendStreamError()

◆ setReplyToError() [1/2]

◆ setReplyToError() [2/2]

◆ setReplyToReply()

◆ setReplyToStoreEntry()

◆ startCollapsingOn()

◆ startError()

◆ storeId()

◆ storeLookupString()

◆ storeNotOKTransferDone()

◆ storeOKTransferDone()

◆ toCbdata()

◆ traceReply()

◆ triggerInitialStoreRead()

Member Data Documentation

◆ CacheHit