#include <http.h>

Inheritance diagram for HttpStateData:

[legend]

Collaboration diagram for HttpStateData:

[legend]

Classes
class	ReuseDecision
	assists in making and relaying entry caching/sharing decision More...

Public Types
typedef CbcPointer< AsyncJob >	Pointer

typedef CbcPointer< BodyProducer >	Pointer

typedef CbcPointer< BodyConsumer >	Pointer

Public Member Functions
void *	operator new (size_t size)

void	operator delete (void *address)

void *	toCbdata () noexcept

	HttpStateData (FwdState *)

	~HttpStateData ()

virtual const Comm::ConnectionPointer &	dataConnection () const

bool	sendRequest ()

void	processReplyHeader ()

void	processReplyBody ()

void	readReply (const CommIoCbParams &io)

virtual void	maybeReadVirginBody ()
	read response data from the network More...

ReuseDecision::Answers	reusableReply (ReuseDecision &decision)

void	processSurrogateControl (HttpReply *)

virtual void	noteMoreBodyDataAvailable (BodyPipe::Pointer)

virtual void	noteBodyProductionEnded (BodyPipe::Pointer)

virtual void	noteBodyProducerAborted (BodyPipe::Pointer)

virtual bool	abortOnData (const char *reason)

virtual HttpRequestPointer	originalRequest ()
	a hack to reach HttpStateData::orignal_request More...

virtual void	noteAdaptationAnswer (const Adaptation::Answer &answer)

virtual void	noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group)

virtual void	noteMoreBodySpaceAvailable (BodyPipe::Pointer)

virtual void	noteBodyConsumerAborted (BodyPipe::Pointer)

virtual void	swanSong ()

virtual bool	doneAll () const
	whether positive goal has been reached More...

void	serverComplete ()

void	markParsedVirginReplyAsWhole (const char *reasonWeAreSure)

bool	canBeCalled (AsyncCall &call) const
	whether we can be called More...

void	callStart (AsyncCall &call)

virtual void	callEnd ()
	called right after the called job method More...

virtual void	callException (const std::exception &e)
	called when the job throws during an async call More...

void	handleStopRequest ()
	process external request to terminate now (i.e. during this async call) More...

Static Public Member Functions
static void	httpBuildRequestHeader (HttpRequest request, StoreEntry entry, const AccessLogEntryPointer &al, HttpHeader *hdr_out, const Http::StateFlags &flags)

static void	Start (const Pointer &job)

Public Attributes
CachePeer *	_peer = nullptr

int	eof = 0

int	lastChunk = 0

Http::StateFlags	flags

SBuf	inBuf
	I/O buffer for receiving server responses. More...

bool	ignoreCacheControl = false

bool	surrogateNoStore = false

String *	upgradeHeaderOut = nullptr
	Upgrade header value sent to the origin server or cache peer. More...

StoreEntry *	entry = nullptr

FwdState::Pointer	fwd

HttpRequestPointer	request

const InstanceId< AsyncJob >	id
	job identifier More...

Protected Member Functions
virtual void	noteDelayAwareReadChance ()

void	processReply ()

void	proceedAfter1xx ()
	restores state and resumes processing after 1xx is ignored or forwarded More...

void	handle1xx (HttpReply *msg)
	ignore or start forwarding the 1xx response (a.k.a., control message) More...

void	drop1xx (const char *reason)

virtual void	completeForwarding ()

bool	startRequestBodyFlow ()

void	handleRequestBodyProductionEnded ()

void	sendMoreRequestBody ()

bool	abortOnBadEntry (const char *abortReason)
	Entry-dependent callbacks use this check to quit if the entry went bad. More...

bool	blockCaching ()
	whether to prevent caching of an otherwise cachable response More...

void	startAdaptation (const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
	Initiate an asynchronous adaptation transaction which will call us back. More...

void	adaptVirginReplyBody (const char *buf, ssize_t len)

void	cleanAdaptation ()

virtual bool	doneWithAdaptation () const

void	handleMoreAdaptedBodyAvailable ()

void	handleAdaptedBodyProductionEnded ()

void	handleAdaptedBodyProducerAborted ()

void	handleAdaptedHeader (Http::Message *msg)

void	handleAdaptationCompleted ()

void	handleAdaptationBlocked (const Adaptation::Answer &answer)

void	handleAdaptationAborted (bool bypassable=false)

bool	handledEarlyAdaptationAbort ()

void	resumeBodyStorage ()
	called by StoreEntry when it has more buffer space available More...

void	endAdaptedBodyConsumption ()
	called when the entire adapted response body is consumed More...

const HttpReply *	virginReply () const

HttpReply *	virginReply ()

HttpReply *	setVirginReply (HttpReply *r)

HttpReply *	finalReply ()

HttpReply *	setFinalReply (HttpReply *r)

void	adaptOrFinalizeReply ()

void	addVirginReplyBody (const char *buf, ssize_t len)

void	storeReplyBody (const char *buf, ssize_t len)

size_t	replyBodySpace (const MemBuf &readBuf, const size_t minSpace) const

size_t	calcBufferSpaceToReserve (const size_t space, const size_t wantSpace) const
	determine how much space the buffer needs to reserve More...

void	adjustBodyBytesRead (const int64_t delta)
	initializes bodyBytesRead stats if needed and applies delta More...

void	delayRead ()

CbcPointer< Initiate >	initiateAdaptation (Initiate *x)
	< starts freshly created initiate and returns a safe pointer to it More...

void	clearAdaptation (CbcPointer< Initiate > &x)
	clears the pointer (does not call announceInitiatorAbort) More...

void	announceInitiatorAbort (CbcPointer< Initiate > &x)
	inform the transaction about abnormal termination and clear the pointer More...

bool	initiated (const CbcPointer< AsyncJob > &job) const
	Must(initiated(initiate)) instead of Must(initiate.set()), for clarity. More...

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

bool	done () const
	the job is destroyed in callEnd() when done() More...

virtual const char *	status () const
	internal cleanup; do not call directly More...

void	stopProducingFor (RefCount< BodyPipe > &, bool atEof)

void	stopConsumingFrom (RefCount< BodyPipe > &)

Protected Attributes
int64_t	currentOffset = 0

MemBuf *	responseBodyBuffer = nullptr

BodyPipe::Pointer	requestBodySource

AsyncCall::Pointer	requestSender

BodyPipe::Pointer	virginBodyDestination

CbcPointer< Adaptation::Initiate >	adaptedHeadSource

BodyPipe::Pointer	adaptedBodySource

bool	adaptationAccessCheckPending = false

bool	startedAdaptation = false

bool	receivedWholeAdaptedReply = false
	handleAdaptedBodyProductionEnded() was called More...

bool	receivedWholeRequestBody = false
	handleRequestBodyProductionEnded called More...

const char *	doneWithFwd = nullptr

const char *	stopReason
	reason for forcing done() to be true More...

const char *	typeName
	kid (leaf) class name, for debugging More...

AsyncCall::Pointer	inCall
	the asynchronous call being handled, if any More...

bool	started_ = false
	Start() has finished successfully. More...

bool	swanSang_ = false
	swanSong() was called More...

Private Types
enum	ConnectionStatus { INCOMPLETE_MSG, COMPLETE_PERSISTENT_MSG, COMPLETE_NONPERSISTENT_MSG }

Private Member Functions
ConnectionStatus	statusIfComplete () const

ConnectionStatus	persistentConnStatus () const

void	keepaliveAccounting (HttpReply *)

void	checkDateSkew (HttpReply *)

bool	continueAfterParsingHeader ()

void	truncateVirginBody ()

virtual void	start ()
	called by AsyncStart; do not call directly More...

virtual void	haveParsedReplyHeaders ()
	called when we have final (possibly adapted) reply headers; kids extend More...

virtual bool	getMoreRequestBody (MemBuf &buf)
	either fill buf with available [encoded] request body bytes or return false More...

virtual void	closeServer ()

virtual bool	doneWithServer () const

virtual void	abortAll (const char *reason)
	abnormal transaction termination; reason is for debugging only More...

virtual bool	mayReadVirginReplyBody () const
	whether we may receive more virgin response body bytes More...

void	abortTransaction (const char *reason)

bool	maybeMakeSpaceAvailable (bool grow)

virtual void	handleMoreRequestBodyAvailable ()

virtual void	handleRequestBodyProducerAborted ()

void	writeReplyBody ()

bool	decodeAndWriteReplyBody ()

bool	finishingBrokenPost ()
	if broken posts are enabled for the request, try to fix and return true More...

bool	finishingChunkedRequest ()
	if needed, write last-chunk to end the request body and return true More...

void	doneSendingRequestBody ()

void	requestBodyHandler (MemBuf &)

virtual void	sentRequestBody (const CommIoCbParams &io)

void	wroteLast (const CommIoCbParams &io)
	called after writing the very last request byte (body, last-chunk, etc) More...

void	sendComplete ()
	successfully wrote the entire request (including body, last-chunk, etc.) More...

void	httpStateConnClosed (const CommCloseCbParams &params)

void	httpTimeout (const CommTimeoutCbParams &params)

mb_size_t	buildRequestPrefix (MemBuf *mb)

void	forwardUpgrade (HttpHeader &)

bool	peerSupportsConnectionPinning () const

const char *	blockSwitchingProtocols (const HttpReply &) const

void	serverComplete2 ()

void	sendBodyIsTooLargeError ()

void	maybePurgeOthers ()

Static Private Member Functions
static bool	decideIfWeDoRanges (HttpRequest *orig_request)

Private Attributes
Comm::ConnectionPointer	serverConnection

AsyncCall::Pointer	closeHandler

Http1::ResponseParserPointer	hp
	Parser being used at present to parse the HTTP/ICY server response. More...

Http1::TeChunkedParser *	httpChunkDecoder = nullptr

int64_t	payloadSeen = 0
	amount of message payload/body received so far. More...

int64_t	payloadTruncated = 0
	positive when we read more than we wanted More...

bool	sawDateGoBack = false

bool	completed = false

HttpReply *	theVirginReply = nullptr

HttpReply *	theFinalReply = nullptr

Static Private Attributes
static cbdata_type	CBDATA_HttpStateData = CBDATA_UNKNOWN

Detailed Description

Definition at line 22 of file http.h.

Member Typedef Documentation

◆ Pointer [1/3]

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

◆ Pointer [2/3]

typedef CbcPointer<BodyProducer> BodyProducer::Pointer

inherited

Definition at line 25 of file BodyPipe.h.

◆ Pointer [3/3]

typedef CbcPointer<BodyConsumer> BodyConsumer::Pointer

inherited

Definition at line 45 of file BodyPipe.h.

Member Enumeration Documentation

◆ ConnectionStatus

enum HttpStateData::ConnectionStatus

private

Enumerator
INCOMPLETE_MSG
COMPLETE_PERSISTENT_MSG
COMPLETE_NONPERSISTENT_MSG

Definition at line 94 of file http.h.

Constructor & Destructor Documentation

◆ HttpStateData()

HttpStateData::HttpStateData ( FwdState * theFwdState )

◆ ~HttpStateData()

HttpStateData::~HttpStateData ( )

Definition at line 113 of file http.cc.

References _peer, cbdataReferenceDone, debugs, httpChunkDecoder, serverConnection, and upgradeHeaderOut.

Member Function Documentation

◆ abortAll()

void HttpStateData::abortAll ( const char * reason )

privatevirtual

Implements Client.

Definition at line 2605 of file http.cc.

References debugs, AsyncJob::mustStop(), and serverConnection.

Referenced by abortTransaction().

◆ abortOnBadEntry()

bool Client::abortOnBadEntry ( const char * abortReason )

protectedinherited

Definition at line 258 of file Client.cc.

References Client::abortOnData(), debugs, Client::entry, and StoreEntry::isAccepting().

Referenced by Client::handleAdaptationAborted(), Client::handleAdaptationBlocked(), Client::handleAdaptedBodyProducerAborted(), Client::handleAdaptedBodyProductionEnded(), Client::handleAdaptedHeader(), Client::handleMoreAdaptedBodyAvailable(), Client::noteAdaptationAclCheckDone(), and Client::resumeBodyStorage().

◆ abortOnData()

bool Client::abortOnData ( const char * reason )

virtualinherited

abnormal data transfer termination

Return values

true	the transaction will be terminated (abortAll called)
false	the transaction will survive

Reimplemented in Ftp::Relay.

Definition at line 311 of file Client.cc.

References Client::abortAll().

Referenced by Client::abortOnBadEntry(), Client::handleAdaptationBlocked(), Client::sendBodyIsTooLargeError(), and Client::sentRequestBody().

◆ abortTransaction()

void HttpStateData::abortTransaction ( const char * reason )

inlineprivate

Definition at line 115 of file http.h.

References abortAll().

Referenced by handleRequestBodyProducerAborted(), processReply(), processReplyBody(), and readReply().

◆ adaptOrFinalizeReply()

void Client::adaptOrFinalizeReply ( )

protectedinherited

Definition at line 996 of file Client.cc.

References Client::adaptationAccessCheckPending, FwdState::al, debugs, Client::fwd, Adaptation::methodRespmod, Client::originalRequest(), Adaptation::pointPreCache, Client::setFinalReply(), Adaptation::AccessCheck::Start(), and Client::virginReply().

Referenced by processReply().

◆ adaptVirginReplyBody()

void Client::adaptVirginReplyBody	(	const char *	buf,
		ssize_t	len
	)

protectedinherited

Definition at line 629 of file Client.cc.

References MemBuf::append(), assert, MemBuf::consume(), MemBuf::content(), MemBuf::contentSize(), debugs, MemBuf::init(), NULL, BodyPipe::putMoreData(), Client::responseBodyBuffer, Client::startedAdaptation, and Client::virginBodyDestination.

Referenced by Client::addVirginReplyBody().

◆ addVirginReplyBody()

void Client::addVirginReplyBody	(	const char *	buf,
		ssize_t	len
	)

protectedinherited

Definition at line 1038 of file Client.cc.

References Client::adaptationAccessCheckPending, Client::adaptVirginReplyBody(), Client::adjustBodyBytesRead(), assert, Client::startedAdaptation, and Client::storeReplyBody().

Referenced by decodeAndWriteReplyBody(), Client::noteMoreBodySpaceAvailable(), and writeReplyBody().

◆ adjustBodyBytesRead()

void Client::adjustBodyBytesRead ( const int64_t delta )

protectedinherited

Definition at line 1014 of file Client.cc.

References HierarchyLogEntry::bodyBytesRead, HttpRequest::hier, Must, and Client::originalRequest().

Referenced by Client::addVirginReplyBody().

◆ announceInitiatorAbort()

void Adaptation::Initiator::announceInitiatorAbort ( CbcPointer< Initiate > & x )

protectedinherited

Definition at line 38 of file Initiator.cc.

References CallJobHere.

Referenced by ClientHttpRequest::~ClientHttpRequest(), and Client::cleanAdaptation().

◆ blockCaching()

bool Client::blockCaching ( )

protectedinherited

Definition at line 552 of file Client.cc.

References SquidConfig::accessList, ACLFilledChecklist::al, FwdState::al, Acl::Answer::allowed(), Config, debugs, Client::entry, ACLChecklist::fastCheck(), MemObject::freshestReply(), Client::fwd, HTTPMSGLOCK(), StoreEntry::mem(), Client::originalRequest(), ACLFilledChecklist::reply, and SquidConfig::storeMiss.

Referenced by Client::setFinalReply().

◆ blockSwitchingProtocols()

const char * HttpStateData::blockSwitchingProtocols ( const HttpReply & reply ) const

private

Return values

nil	if the HTTP/101 (Switching Protocols) reply should be forwarded
reason	why an attempt to switch protocols should be stopped

Definition at line 823 of file http.cc.

References Http::CONNECTION, debugs, HttpHeader::getList(), HttpHeader::has(), HttpHeader::hasListMember(), Http::Message::header, strListGetItem(), Http::UPGRADE, and upgradeHeaderOut.

Referenced by handle1xx().

◆ buildRequestPrefix()

mb_size_t HttpStateData::buildRequestPrefix ( MemBuf * mb )

private

Definition at line 2284 of file http.cc.

References FwdState::al, MemBuf::append(), Packable::appendf(), assert, Http::AUTHORIZATION, RequestFlags::authSent, HttpHeader::clean(), RequestFlags::connectionAuth, crlf, HttpRequest::effectiveRequestUri(), Client::entry, flags, HttpRequest::flags, forwardUpgrade(), Client::fwd, HttpHeader::getList(), RefCount< C >::getRaw(), HttpHeader::has(), hoRequest, httpBuildRequestHeader(), HttpRequestMethod::image(), AnyP::ProtocolVersion::major, HttpRequest::method, AnyP::ProtocolVersion::minor, HttpHeader::packInto(), AnyP::Uri::path(), RequestFlags::pinned, AnyP::ProtocolVersion::protocol, AnyP::ProtocolType_str, Http::ProtocolVersion(), Client::request, MemBuf::size, SQUIDSBUFPH, SQUIDSBUFPRINT, Http::StateFlags::toOrigin, Http::UPGRADE, upgradeHeaderOut, and HttpRequest::url.

Referenced by sendRequest().

◆ calcBufferSpaceToReserve()

size_t Client::calcBufferSpaceToReserve	(	const size_t	space,
		const size_t	wantSpace
	)		const

protectedinherited

Definition at line 1063 of file Client.cc.

References BodyPipe::buf(), debugs, SBuf::maxSize, min(), NULL, MemBuf::potentialSpaceSize(), Client::responseBodyBuffer, and Client::virginBodyDestination.

Referenced by maybeMakeSpaceAvailable().

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 137 of file AsyncJob.cc.

References assert, AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), AsyncJob::inCall, NULL, AsyncJob::started_, AsyncJob::status(), AsyncJob::swanSang_, AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

◆ callException()

void AsyncJob::callException ( const std::exception & e )

virtualinherited

Reimplemented in Ftp::Server, Ipc::Inquirer, Ipc::Forwarder, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, Adaptation::Icap::ModXact, ClientHttpRequest, and ConnStateData.

Definition at line 128 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by ConnStateData::callException(), Adaptation::Icap::Xaction::callException(), Ipc::Forwarder::callException(), Ipc::Inquirer::callException(), and Ftp::Server::callException().

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 115 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall & call ) const

inherited

Definition at line 102 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, AsyncJob::inCall, and NULL.

◆ checkDateSkew()

void HttpStateData::checkDateSkew ( HttpReply * reply )

private

Definition at line 624 of file http.cc.

References HttpReply::date, debugs, flags, AnyP::Uri::host(), Client::request, squid_curtime, Http::StateFlags::toOrigin, and HttpRequest::url.

Referenced by processReplyHeader().

◆ cleanAdaptation()

void Client::cleanAdaptation ( )

protectedinherited

Definition at line 604 of file Client.cc.

References Client::adaptationAccessCheckPending, Client::adaptedBodySource, Client::adaptedHeadSource, Adaptation::Initiator::announceInitiatorAbort(), assert, debugs, Client::doneWithAdaptation(), NULL, BodyConsumer::stopConsumingFrom(), BodyProducer::stopProducingFor(), and Client::virginBodyDestination.

Referenced by Client::handleAdaptationCompleted(), and Client::swanSong().

◆ clearAdaptation()

void Adaptation::Initiator::clearAdaptation ( CbcPointer< Initiate > & x )

protectedinherited

Definition at line 32 of file Initiator.cc.

References CbcPointer< Cbc >::clear().

Referenced by ClientHttpRequest::handleAdaptedHeader(), ClientHttpRequest::noteAdaptationAnswer(), and Client::noteAdaptationAnswer().

◆ closeServer()

void HttpStateData::closeServer ( )

privatevirtual

Use this to end communication with the server. The call cancels our closure handler and tells FwdState to forget about the connection.

Implements Client.

Definition at line 1692 of file http.cc.

References Comm::Connection::close(), closeHandler, comm_remove_close_handler(), debugs, Comm::Connection::fd, Client::fwd, Comm::IsConnOpen(), NULL, serverConnection, and FwdState::unregister().

Referenced by continueAfterParsingHeader(), drop1xx(), handleMoreRequestBodyAvailable(), httpTimeout(), readReply(), and wroteLast().

◆ completeForwarding()

void Client::completeForwarding ( )

protectedvirtualinherited

default calls fwd->complete()

Reimplemented in Ftp::Relay, and Ftp::Gateway.

Definition at line 230 of file Client.cc.

References assert, FwdState::complete(), debugs, Client::doneWithFwd, Client::fwd, and NULL.

Referenced by Ftp::Gateway::completeForwarding(), Ftp::Relay::completeForwarding(), Client::handleAdaptationCompleted(), and Client::serverComplete2().

◆ continueAfterParsingHeader()

bool HttpStateData::continueAfterParsingHeader ( )

private

Return values

true	if we can continue with processing the body or doing ICAP.

Return values

false If we have not finished parsing the headers and may get more data. Schedules more reads to retrieve the missing data.

If we are done with parsing, check for errors

Definition at line 1302 of file http.cc.

References RequestFlags::accelerated, FwdState::al, assert, closeServer(), DBG_IMPORTANT, debugs, Http::StateFlags::do_next_read, FwdState::dontRetry(), Client::entry, eof, ERR_INVALID_RESP, ERR_NONE, ERR_TOO_BIG, ERR_ZERO_SIZE_OBJECT, error(), FwdState::fail(), flags, HttpRequest::flags, Client::fwd, Http::StateFlags::handling1xx, Http::StateFlags::headers_parsed, inBuf, SBuf::length(), maybeReadVirginBody(), Must, AsyncJob::mustStop(), Http::ProtocolVersion(), Client::request, FwdState::request, StoreEntry::reset(), Http::scBadGateway, Http::scHeaderTooLarge, Http::scInvalidHeader, HttpRequest::url, StoreEntry::url(), and Client::virginReply().

Referenced by processReply().

◆ dataConnection()

const Comm::ConnectionPointer & HttpStateData::dataConnection ( ) const

virtual

Returns: primary or "request data connection"

Implements Client.

Definition at line 130 of file http.cc.

References serverConnection.

◆ decideIfWeDoRanges()

bool HttpStateData::decideIfWeDoRanges ( HttpRequest * orig_request )

staticprivate

Definition at line 2254 of file http.cc.

References RequestFlags::cachable, RequestFlags::connectionAuth, debugs, HttpRequest::flags, HttpRequest::getRangeOffsetLimit(), NULL, HttpHdrRange::offsetLimitExceeded(), HttpRequest::range, and Client::request.

Referenced by httpBuildRequestHeader().

◆ decodeAndWriteReplyBody()

bool HttpStateData::decodeAndWriteReplyBody ( )

private

Definition at line 1423 of file http.cc.

References Client::addVirginReplyBody(), assert, Http::StateFlags::chunked, MemBuf::content(), MemBuf::contentSize(), CurrentException(), debugs, Http::StateFlags::do_next_read, flags, httpChunkDecoder, inBuf, MemBuf::init(), lastChunk, Client::markParsedVirginReplyAsWhole(), Http::One::TeChunkedParser::parse(), Http::One::Parser::remaining(), and Http::One::TeChunkedParser::setPayloadBuffer().

Referenced by processReplyBody().

◆ delayRead()

void Client::delayRead ( )

protectedinherited

Defer reading until it is likely to become possible. Eventually, noteDelayAwareReadChance() will be called.

Definition at line 1029 of file Client.cc.

References asyncCall(), MemObject::delayRead(), Client::entry, StoreEntry::mem(), and Client::noteDelayAwareReadChance().

Referenced by readReply().

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 50 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed().

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 91 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), HappyConnOpener::checkForNewConnection(), Downloader::downloadFinished(), and HappyConnOpener::maybeOpenPrimeConnection().

◆ doneAll()

bool Client::doneAll ( ) const

virtualinherited

Reimplemented from AsyncJob.

Definition at line 217 of file Client.cc.

References AsyncJob::doneAll(), Client::doneWithAdaptation(), and Client::doneWithServer().

◆ doneSendingRequestBody()

void HttpStateData::doneSendingRequestBody ( )

privatevirtual

Implements Client.

Definition at line 2528 of file http.cc.

References Http::StateFlags::chunked_request, debugs, Client::doneSendingRequestBody(), finishingBrokenPost(), finishingChunkedRequest(), flags, sendComplete(), and serverConnection.

◆ doneWithAdaptation()

bool Client::doneWithAdaptation ( ) const

protectedvirtualinherited

did we end ICAP communication?

Definition at line 621 of file Client.cc.

References Client::adaptationAccessCheckPending, Client::adaptedBodySource, Client::adaptedHeadSource, and Client::virginBodyDestination.

Referenced by Client::cleanAdaptation(), Client::doneAll(), Client::handleAdaptedHeader(), Client::noteBodyConsumerAborted(), and Client::serverComplete2().

◆ doneWithServer()

bool HttpStateData::doneWithServer ( ) const

privatevirtual

did we end communication?

Implements Client.

Definition at line 1705 of file http.cc.

References Comm::IsConnOpen(), and serverConnection.

Referenced by mayReadVirginReplyBody().

◆ drop1xx()

void HttpStateData::drop1xx ( const char * reason )

protected

if possible, safely ignores the received 1xx control message otherwise, terminates the server connection

Definition at line 805 of file http.cc.

References FwdState::al, closeServer(), debugs, ERR_INVALID_RESP, FwdState::fail(), flags, Client::fwd, RefCount< C >::getRaw(), AsyncJob::mustStop(), proceedAfter1xx(), Client::request, Http::scBadGateway, and Http::StateFlags::serverSwitchedProtocols.

Referenced by handle1xx().

◆ endAdaptedBodyConsumption()

void Client::endAdaptedBodyConsumption ( )

protectedinherited

Definition at line 830 of file Client.cc.

References Client::adaptedBodySource, Client::fwd, Client::handleAdaptationCompleted(), FwdState::markStoredReplyAsWhole(), Client::receivedWholeAdaptedReply, and BodyConsumer::stopConsumingFrom().

Referenced by Client::handleAdaptedBodyProductionEnded(), and Client::resumeBodyStorage().

◆ finalReply()

HttpReply * Client::finalReply ( )

protectedinherited

Definition at line 129 of file Client.cc.

References assert, and Client::theFinalReply.

Referenced by haveParsedReplyHeaders(), and reusableReply().

◆ finishingBrokenPost()

bool HttpStateData::finishingBrokenPost ( )

private

Definition at line 2476 of file http.cc.

References SquidConfig::accessList, ACLFilledChecklist::al, FwdState::al, Acl::Answer::allowed(), assert, SquidConfig::brokenPosts, closeHandler, Config, debugs, ACLChecklist::fastCheck(), Client::fwd, Comm::IsConnOpen(), JobCallback, NULL, Client::originalRequest(), Client::requestSender, serverConnection, ACLFilledChecklist::syncAle(), Comm::Write(), and wroteLast().

Referenced by doneSendingRequestBody().

◆ finishingChunkedRequest()

bool HttpStateData::finishingChunkedRequest ( )

private

Definition at line 2511 of file http.cc.

References debugs, flags, JobCallback, Must, NULL, Client::receivedWholeRequestBody, Client::requestSender, Http::StateFlags::sentLastChunk, serverConnection, Comm::Write(), and wroteLast().

Referenced by doneSendingRequestBody().

◆ forwardUpgrade()

void HttpStateData::forwardUpgrade ( HttpHeader & hdrOut )

private

copies from-client Upgrade info into the given to-server header while honoring configuration filters and following HTTP requirements

Definition at line 2002 of file http.cc.

References acl_access, ACLFilledChecklist::al, FwdState::al, ACLChecklist::changeAcl(), Config, Http::CONNECTION, debugs, ACLChecklist::fastCheck(), flags, HttpUpgradeProtocolAccess::forApplicable(), Http::StateFlags::forceClose, Client::fwd, HttpHeader::getList(), RefCount< C >::getRaw(), Http::Message::header, SquidConfig::http_upgrade_request_protocols, Http::Message::http_ver, Http::StateFlags::keepalive, Http::ProtocolVersion(), HttpHeader::putStr(), Client::request, String::size(), strListAdd(), strListGetItem(), String::termedBuf(), and Http::UPGRADE.

Referenced by buildRequestPrefix().

◆ getMoreRequestBody()

bool HttpStateData::getMoreRequestBody ( MemBuf & buf )

privatevirtual

Reimplemented from Client.

Definition at line 2415 of file http.cc.

References MemBuf::append(), Packable::appendf(), Http::StateFlags::chunked_request, MemBuf::content(), MemBuf::contentSize(), flags, BodyPipe::getMoreData(), Client::getMoreRequestBody(), MemBuf::init(), MemBuf::max_capacity, Must, NULL, Client::receivedWholeRequestBody, Client::requestBodySource, and Http::StateFlags::sentLastChunk.

◆ handle1xx()

void HttpStateData::handle1xx ( HttpReply * msg )

protected

◆ handleAdaptationAborted()

void Client::handleAdaptationAborted ( bool bypassable = false )

protectedinherited

Definition at line 885 of file Client.cc.

References Client::abortAll(), Client::abortOnBadEntry(), debugs, Client::entry, Client::handledEarlyAdaptationAbort(), and StoreEntry::isEmpty().

Referenced by Client::noteAdaptationAnswer().

◆ handleAdaptationBlocked()

void Client::handleAdaptationBlocked ( const Adaptation::Answer & answer )

protectedinherited

◆ handleAdaptationCompleted()

void Client::handleAdaptationCompleted ( )

protectedinherited

Definition at line 866 of file Client.cc.

References Client::cleanAdaptation(), Client::closeServer(), Client::completeForwarding(), debugs, and Client::mayReadVirginReplyBody().

Referenced by Client::endAdaptedBodyConsumption(), Client::handleAdaptedBodyProducerAborted(), Client::handleAdaptedHeader(), and Client::noteBodyConsumerAborted().

◆ handleAdaptedBodyProducerAborted()

void Client::handleAdaptedBodyProducerAborted ( )

protectedinherited

Definition at line 845 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptedBodySource, debugs, BodyPipe::exhausted(), Client::handleAdaptationCompleted(), Client::handledEarlyAdaptationAbort(), Must, and BodyConsumer::stopConsumingFrom().

Referenced by Client::noteBodyProducerAborted().

◆ handleAdaptedBodyProductionEnded()

void Client::handleAdaptedBodyProductionEnded ( )

protectedinherited

Definition at line 815 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptedBodySource, Client::endAdaptedBodyConsumption(), BodyPipe::exhausted(), NULL, and Client::receivedWholeAdaptedReply.

Referenced by Client::noteBodyProductionEnded().

◆ handleAdaptedHeader()

void Client::handleAdaptedHeader ( Http::Message * msg )

protectedinherited

Definition at line 717 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptedBodySource, assert, Http::Message::body_pipe, debugs, Client::doneWithAdaptation(), BodyPipe::expectNoConsumption(), Client::fwd, Client::handleAdaptationCompleted(), FwdState::markStoredReplyAsWhole(), NULL, BodyPipe::setConsumerIfNotLate(), and Client::setFinalReply().

Referenced by Client::noteAdaptationAnswer().

◆ handledEarlyAdaptationAbort()

bool Client::handledEarlyAdaptationAbort ( )

protectedinherited

If the store entry is still empty, fully handles adaptation abort, returning true. Otherwise just updates the request error detail and returns false.

Definition at line 901 of file Client.cc.

References Client::abortAll(), FwdState::al, debugs, HttpRequest::detailError(), FwdState::dontRetry(), Client::entry, ERR_ICAP_FAILURE, FwdState::fail(), Client::fwd, RefCount< C >::getRaw(), StoreEntry::isEmpty(), MakeNamedErrorDetail(), Client::request, and Http::scInternalServerError.

Referenced by Client::handleAdaptationAborted(), and Client::handleAdaptedBodyProducerAborted().

◆ handleMoreAdaptedBodyAvailable()

void Client::handleMoreAdaptedBodyAvailable ( )

protectedinherited

◆ handleMoreRequestBodyAvailable()

void HttpStateData::handleMoreRequestBodyAvailable ( )

privatevirtual

◆ handleRequestBodyProducerAborted()

void HttpStateData::handleRequestBodyProducerAborted ( )

privatevirtual

Implements Client.

Definition at line 2576 of file http.cc.

References abortTransaction(), FwdState::al, debugs, Client::entry, ERR_ICAP_FAILURE, FwdState::fail(), Client::fwd, Client::handleRequestBodyProducerAborted(), StoreEntry::isEmpty(), MakeNamedErrorDetail(), FwdState::request, Http::scInternalServerError, and serverConnection.

◆ handleRequestBodyProductionEnded()

void Client::handleRequestBodyProductionEnded ( )

protectedinherited

Definition at line 329 of file Client.cc.

References debugs, Client::doneSendingRequestBody(), Client::receivedWholeRequestBody, and Client::requestSender.

Referenced by Client::noteBodyProductionEnded().

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ haveParsedReplyHeaders()

void HttpStateData::haveParsedReplyHeaders ( )

privatevirtual

called when got final headers

Reimplemented from Client.

Definition at line 937 of file http.cc.

References assert, Http::Message::cache_control, HttpStateData::ReuseDecision::cacheNegatively, StoreEntry::cacheNegatively(), HttpStateData::ReuseDecision::cachePositively, debugs, HttpStateData::ReuseDecision::doNotCacheButShare, EBIT_SET, Client::entry, ENTRY_FWD_HDR_WAIT, ENTRY_REVALIDATE_ALWAYS, ENTRY_REVALIDATE_STALE, Client::finalReply(), findPreviouslyCachedEntry(), StoreEntry::flags, Client::fwd, RefCount< C >::getRaw(), HttpHeader::has(), HttpHeader::hasListMember(), HttpHdrCc::hasMustRevalidate(), HttpHdrCc::hasNoCacheWithoutParameters(), HttpHdrCc::hasPrivate(), HttpHdrCc::hasProxyRevalidate(), HttpHdrCc::hasSMaxAge(), Client::haveParsedReplyHeaders(), Http::HDR_X_ACCELERATOR_VARY, Http::Message::header, httpMakeVaryMark(), httpMaybeRemovePublic(), ignoreCacheControl, SBuf::isEmpty(), HttpStateData::ReuseDecision::make(), StoreEntry::makePrivate(), StoreEntry::makePublic(), StoreEntry::mem_obj, HttpRequest::method, neighbors_do_private_keys, HttpReply::olderThan(), Http::PRAGMA, FwdState::reforwardableStatus(), Client::request, reusableReply(), HttpStateData::ReuseDecision::reuseNot, sawDateGoBack, HttpReply::sline, Http::StatusLine::status(), StoreEntry::timestampsSet(), Http::VARY, and MemObject::vary_headers.

◆ httpBuildRequestHeader()

void HttpStateData::httpBuildRequestHeader	(	HttpRequest *	request,
		StoreEntry *	entry,
		const AccessLogEntryPointer &	al,
		HttpHeader *	hdr_out,
		const Http::StateFlags &	flags
	)

static

Precondition: Handle X-Forwarded-For

If set to ON - append client IP or 'unknown'.

If set to OFF - append 'unknown'.

If set to TRANSPARENT - pass through unchanged.

If set to TRUNCATE - drop existing list and replace with client IP or 'unknown'.

If set to DELETE - do not copy through.

Definition at line 1825 of file http.cc.

References SquidConfig::Accel, RequestFlags::accelerated, HttpHeader::addEntry(), HttpHeader::addVia(), assert, AnyP::Uri::authority(), Http::AUTHORIZATION, base64_encode_final(), base64_encode_init(), base64_encode_len, base64_encode_update(), BBUF_SZ, SBuf::c_str(), RequestFlags::cachable, String::canGrowBy(), Http::StateFlags::chunked_request, String::clean(), HttpRequest::client_addr, Config, Http::CONNECTION, copyOneHeaderFromClientsideRequestToUpstreamRequest(), DBG_IMPORTANT, debugs, decideIfWeDoRanges(), HttpRequest::effectiveRequestUri(), Client::entry, HttpRequest::etag, flags, HttpRequest::flags, Http::FRONT_END_HTTPS, Http::StateFlags::front_end_https, HttpHeader::getCc(), HttpHeader::getEntry(), HttpHeader::getList(), getMaxAge(), AnyP::Uri::getScheme(), HttpHeader::has(), HttpHdrCc::hasMaxAge(), HttpHdrCc::hasNoCache(), Http::Message::header, hoRequest, Http::HOST, Http::Message::http_ver, httpFixupAuthentication(), httpHdrMangleList(), HttpHeaderInitPos, httpHeaderPutStrf(), Http::IF_MODIFIED_SINCE, Http::IF_NONE_MATCH, HttpRequest::ignoreRange(), Ip::Address::isNoAddr(), RequestFlags::isRanged, Http::StateFlags::keepalive, HttpRequest::lastmod, LOCAL_ARRAY, MAX_IPSTRLEN, MAX_URL, HttpHdrCc::maxAge(), HttpRequest::multipartRangeRequest(), NULL, Http::StateFlags::only_if_cached, HttpHdrCc::onlyIfCached(), opt_forwarded_for, HttpHeader::owner, HttpRequest::peer_domain, AnyP::PROTO_HTTPS, HttpHeader::putCc(), HttpHeader::putStr(), HttpHeader::putTime(), Client::request, ROR_REQUEST, String::size(), strListAdd(), Http::SURROGATE_CAPABILITY, SquidConfig::surrogate_id, String::termedBuf(), Http::StateFlags::toOrigin, Ip::Address::toStr(), Http::TRANSFER_ENCODING, HttpRequest::url, StoreEntry::url(), AnyP::Uri::userInfo(), and Http::X_FORWARDED_FOR.

Referenced by buildRequestPrefix(), htcpClear(), htcpQuery(), and Http::Tunneler::writeRequest().

◆ httpStateConnClosed()

void HttpStateData::httpStateConnClosed ( const CommCloseCbParams & params )

private

Definition at line 136 of file http.cc.

References CommCommonCbParams::data, debugs, Client::doneWithFwd, CommCommonCbParams::fd, and AsyncJob::mustStop().

Referenced by HttpStateData().

◆ httpTimeout()

void HttpStateData::httpTimeout ( const CommTimeoutCbParams & params )

private

Definition at line 144 of file http.cc.

References FwdState::al, closeServer(), debugs, Client::entry, ERR_READ_TIMEOUT, FwdState::fail(), Client::fwd, AsyncJob::mustStop(), FwdState::request, Http::scGatewayTimeout, serverConnection, STORE_PENDING, StoreEntry::store_status, and StoreEntry::url().

Referenced by sendComplete(), and sendRequest().

◆ initiateAdaptation()

CbcPointer< Adaptation::Initiate > Adaptation::Initiator::initiateAdaptation ( Initiate * x )

protectedinherited

Definition at line 23 of file Initiator.cc.

References Adaptation::Initiate::initiator(), and Ident::Start().

Referenced by ClientHttpRequest::startAdaptation(), and Client::startAdaptation().

◆ initiated()

bool Adaptation::Initiator::initiated ( const CbcPointer< AsyncJob > & job ) const

inlineprotectedinherited

Definition at line 52 of file Initiator.h.

References CbcPointer< Cbc >::set().

Referenced by ClientHttpRequest::startAdaptation(), and Client::startAdaptation().

◆ keepaliveAccounting()

void HttpStateData::keepaliveAccounting ( HttpReply * reply )

private

◆ markParsedVirginReplyAsWhole()

void Client::markParsedVirginReplyAsWhole ( const char * reasonWeAreSure )

inherited

remember that the received virgin reply was parsed in its entirety, including its body (if any)

Definition at line 158 of file Client.cc.

References assert, debugs, Client::fwd, FwdState::markStoredReplyAsWhole(), and Client::startedAdaptation.

Referenced by decodeAndWriteReplyBody(), ftpReadTransferDone(), and writeReplyBody().

◆ maybeMakeSpaceAvailable()

bool HttpStateData::maybeMakeSpaceAvailable ( bool grow )

private

determine if read buffer can have space made available for a read.

Parameters

grow	whether to actually expand the buffer

Returns: whether the buffer can be grown to provide space regardless of whether the grow actually happened.

Definition at line 1599 of file http.cc.

References Client::calcBufferSpaceToReserve(), Config, DBG_DATA, debugs, Http::StateFlags::do_next_read, flags, Http::StateFlags::headers_parsed, inBuf, SBuf::length(), SquidConfig::maxReplyHeaderSize, processReply(), SquidConfig::readAheadGap, SBuf::reserveSpace(), serverConnection, and SBuf::spaceSize().

Referenced by maybeReadVirginBody(), and readReply().

◆ maybePurgeOthers()

void Client::maybePurgeOthers ( )

privateinherited

Definition at line 516 of file Client.cc.

References SBuf::c_str(), Http::CONTENT_LOCATION, debugs, HttpRequest::effectiveRequestUri(), RefCount< C >::getRaw(), Http::LOCATION, HttpRequest::method, purgeEntriesByHeader(), purgeEntriesByUrl(), HttpRequestMethod::purgesOthers(), Client::request, HttpReply::sline, Http::StatusLine::status(), and Client::theFinalReply.

Referenced by Client::haveParsedReplyHeaders().

◆ maybeReadVirginBody()

void HttpStateData::maybeReadVirginBody ( )

virtual

Implements Client.

Definition at line 1573 of file http.cc.

References assert, Http::StateFlags::do_next_read, Comm::Connection::fd, fd_table, flags, Comm::IsConnOpen(), JobCallback, maybeMakeSpaceAvailable(), Comm::MonitorsRead(), Comm::Read(), readReply(), and serverConnection.

Referenced by continueAfterParsingHeader(), noteDelayAwareReadChance(), processReplyBody(), readReply(), and sendRequest().

◆ mayReadVirginReplyBody()

bool HttpStateData::mayReadVirginReplyBody ( ) const

privatevirtual

Implements Client.

Definition at line 1564 of file http.cc.

References doneWithServer().

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

Definition at line 70 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by abortAll(), AsyncJob::callException(), continueAfterParsingHeader(), drop1xx(), handleMoreRequestBodyAvailable(), AsyncJob::handleStopRequest(), httpStateConnClosed(), httpTimeout(), proceedAfter1xx(), ConnStateData::proxyProtocolError(), readReply(), start(), and wroteLast().

◆ noteAdaptationAclCheckDone()

void Client::noteAdaptationAclCheckDone ( Adaptation::ServiceGroupPointer group )

virtualinherited

AccessCheck calls this back with a possibly nil service group to signal whether adaptation is needed and where it should start.

Reimplemented from Adaptation::Initiator.

Definition at line 957 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptationAccessCheckPending, debugs, Client::originalRequest(), Client::processReplyBody(), Client::request, Client::sendBodyIsTooLargeError(), Client::setFinalReply(), Client::startAdaptation(), and Client::virginReply().

◆ noteAdaptationAnswer()

void Client::noteAdaptationAnswer ( const Adaptation::Answer & answer )

virtualinherited

called with the initial adaptation decision (adapt, block, error); virgin and/or adapted body transmission may continue after this

Implements Adaptation::Initiator.

Definition at line 697 of file Client.cc.

References Client::adaptedHeadSource, Adaptation::Answer::akBlock, Adaptation::Answer::akError, Adaptation::Answer::akForward, Adaptation::Initiator::clearAdaptation(), Adaptation::Answer::final, RefCount< C >::getRaw(), Client::handleAdaptationAborted(), Client::handleAdaptationBlocked(), Client::handleAdaptedHeader(), Adaptation::Answer::kind, and Adaptation::Answer::message.

◆ noteBodyConsumerAborted()

void Client::noteBodyConsumerAborted ( BodyPipe::Pointer )

virtualinherited

Implements BodyProducer.

Definition at line 685 of file Client.cc.

References Client::doneWithAdaptation(), Client::handleAdaptationCompleted(), BodyProducer::stopProducingFor(), and Client::virginBodyDestination.

◆ noteBodyProducerAborted()

void Client::noteBodyProducerAborted ( BodyPipe::Pointer bp )

virtualinherited

Implements BodyConsumer.

Definition at line 298 of file Client.cc.

References Client::adaptedBodySource, Client::handleAdaptedBodyProducerAborted(), Client::handleRequestBodyProducerAborted(), and Client::requestBodySource.

◆ noteBodyProductionEnded()

void Client::noteBodyProductionEnded ( BodyPipe::Pointer bp )

virtualinherited

Implements BodyConsumer.

Definition at line 284 of file Client.cc.

References Client::adaptedBodySource, Client::handleAdaptedBodyProductionEnded(), Client::handleRequestBodyProductionEnded(), and Client::requestBodySource.

◆ noteDelayAwareReadChance()

void HttpStateData::noteDelayAwareReadChance ( )

protectedvirtual

Called when a previously delayed dataConnection() read may be possible.

See also: delayRead()

Implements Client.

Definition at line 1168 of file http.cc.

References Http::StateFlags::do_next_read, flags, and maybeReadVirginBody().

◆ noteMoreBodyDataAvailable()

void Client::noteMoreBodyDataAvailable ( BodyPipe::Pointer bp )

virtualinherited

Implements BodyConsumer.

Definition at line 270 of file Client.cc.

References Client::adaptedBodySource, Client::handleMoreAdaptedBodyAvailable(), Client::handleMoreRequestBodyAvailable(), and Client::requestBodySource.

◆ noteMoreBodySpaceAvailable()

void Client::noteMoreBodySpaceAvailable ( BodyPipe::Pointer )

virtualinherited

Implements BodyProducer.

Definition at line 671 of file Client.cc.

References Client::addVirginReplyBody(), Client::completed, Client::maybeReadVirginBody(), NULL, Client::responseBodyBuffer, and Client::serverComplete2().

◆ operator delete()

void HttpStateData::operator delete ( void * address )

inline

Definition at line 24 of file http.h.

◆ operator new()

void* HttpStateData::operator new ( size_t size )

inline

Definition at line 24 of file http.h.

◆ originalRequest()

HttpRequestPointer Client::originalRequest ( )

virtualinherited

Definition at line 570 of file Client.cc.

References Client::request.

Referenced by Client::adaptOrFinalizeReply(), Client::adjustBodyBytesRead(), Client::blockCaching(), finishingBrokenPost(), handle1xx(), Client::noteAdaptationAclCheckDone(), Client::serverComplete(), and Client::startRequestBodyFlow().

◆ peerSupportsConnectionPinning()

bool HttpStateData::peerSupportsConnectionPinning ( ) const

private

returns true if the peer can support connection pinning

Definition at line 879 of file http.cc.

References _peer, CachePeer::connection_auth, Client::entry, flags, HttpRequest::flags, MemObject::freshestReply(), StoreEntry::mem(), CachePeer::options, CachePeer::originserver, RequestFlags::pinned, Http::PROXY_SUPPORT, Client::request, Http::scUnauthorized, and Http::StateFlags::tunneling.

Referenced by processReplyHeader().

◆ persistentConnStatus()

HttpStateData::ConnectionStatus HttpStateData::persistentConnStatus ( ) const

private

: In chunked response we do not know the content length but we are absolutely sure about the end of response, so we are calling the statusIfComplete to decide if we can be persistent

: If the body size is known, we must wait until we've gotten all of it.

: If there is no message body or we got it all, we can be persistent

Definition at line 1118 of file http.cc.

References HttpReply::bodySize(), Http::StateFlags::chunked, COMPLETE_NONPERSISTENT_MSG, Http::Message::content_length, debugs, eof, flags, INCOMPLETE_MSG, Comm::IsConnOpen(), lastChunk, HttpRequest::method, payloadSeen, payloadTruncated, Client::request, serverConnection, statusIfComplete(), and Client::virginReply().

Referenced by processReplyBody().

◆ proceedAfter1xx()

void HttpStateData::proceedAfter1xx ( )

protected

Definition at line 850 of file http.cc.

References asyncCall(), CallJobHere, HttpRequest::clientConnectionManager, closeHandler, comm_remove_close_handler(), debugs, Client::doneWithFwd, Comm::Connection::fd, flags, Client::fwd, Http::StateFlags::handling1xx, inBuf, Must, AsyncJob::mustStop(), ConnStateData::noteTakeServerConnectionControl(), payloadSeen, processReply(), Client::request, ScheduleCallHere, serverConnection, Http::StateFlags::serverSwitchedProtocols, and FwdState::unregister().

Referenced by drop1xx(), and handle1xx().

◆ processReply()

void HttpStateData::processReply ( )

protected

processes the already read and buffered response data, possibly after waiting for asynchronous 1xx control message processing

Definition at line 1271 of file http.cc.

References abortTransaction(), Client::adaptOrFinalizeReply(), continueAfterParsingHeader(), debugs, EBIT_TEST, Client::entry, ENTRY_ABORTED, flags, StoreEntry::flags, Http::StateFlags::handling1xx, Http::StateFlags::headers_parsed, Must, processReplyBody(), and processReplyHeader().

Referenced by maybeMakeSpaceAvailable(), proceedAfter1xx(), and readReply().

◆ processReplyBody()

void HttpStateData::processReplyBody ( )

virtual

processReplyBody has two purposes: 1 - take the reply body data, if any, and put it into either the StoreEntry, or give it over to ICAP. 2 - see if we made it to the end of the response (persistent connections and such)

Implements Client.

Definition at line 1455 of file http.cc.

References abortTransaction(), Client::adaptationAccessCheckPending, RequestFlags::authSent, CallJobHere1, Http::StateFlags::chunked, HttpRequest::client_addr, HttpRequest::clientConnectionManager, closeHandler, comm_remove_close_handler(), commSetConnTimeout(), commUnsetConnTimeout(), COMPLETE_NONPERSISTENT_MSG, COMPLETE_PERSISTENT_MSG, Config, RequestFlags::connectionAuth, debugs, decodeAndWriteReplyBody(), Http::StateFlags::do_next_read, EBIT_TEST, Client::entry, ENTRY_ABORTED, Comm::Connection::fd, flags, HttpRequest::flags, StoreEntry::flags, Client::fwd, fwdPconnPool, Http::StateFlags::headers_parsed, AnyP::Uri::host(), INCOMPLETE_MSG, StoreEntry::isAccepting(), Http::StateFlags::keepalive_broken, maybeReadVirginBody(), Store::nil, NULL, persistentConnStatus(), RequestFlags::pinned, PconnPool::push(), SquidConfig::read, Client::request, Client::serverComplete(), serverConnection, RequestFlags::spoofClientIp, SquidConfig::Timeout, FwdState::unregister(), HttpRequest::url, CbcPointer< Cbc >::valid(), and writeReplyBody().

Referenced by processReply().

◆ processReplyHeader()

void HttpStateData::processReplyHeader ( )

This creates the error page itself.. its likely that the forward ported reply header max size patch generates non http conformant error pages - in which case the errors where should be 'BAD_GATEWAY' etc

Creates a blank header. If this routine is made incremental, this will not do

Definition at line 641 of file http.cc.

References assert, checkDateSkew(), Http::StateFlags::chunked, HttpHeader::chunked(), RequestFlags::connectionAuthDisabled, debugs, Client::entry, eof, flags, HttpRequest::flags, StoreEntry::getMD5Text(), AnyP::Uri::getScheme(), handle1xx(), Http::Message::header, Http::StateFlags::headers_parsed, HttpRequest::hier, hp, httpChunkDecoder, inBuf, Http::Is1xx(), keepaliveAccounting(), SBuf::length(), NULL, HttpReply::parseHeader(), payloadSeen, HierarchyLogEntry::peer_reply_status, peerSupportsConnectionPinning(), processSurrogateControl(), AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, AnyP::ProtocolVersion::protocol, Http::ProtocolVersion(), HttpReply::removeStaleWarnings(), Client::request, Http::scInvalidHeader, serverConnection, Http::StatusLine::set(), Client::setVirginReply(), HttpReply::sline, Http::Message::sources, Http::Message::srcHttp, Http::Message::srcHttps, Http::StatusLine::status(), HttpRequest::url, and Http::StatusLine::version.

Referenced by processReply().

◆ processSurrogateControl()

void HttpStateData::processSurrogateControl ( HttpReply * reply )

◆ readReply()

void HttpStateData::readReply ( const CommIoCbParams & io )

Definition at line 1175 of file http.cc.

References abortTransaction(), FwdState::al, StatCounters::all, DelayId::bytesIn(), StoreEntry::bytesWanted(), closeServer(), CommCommonCbParams::conn, debugs, Client::delayRead(), Http::StateFlags::do_next_read, EBIT_TEST, Comm::ENDFILE, Client::entry, ENTRY_ABORTED, eof, Comm::ERR_CLOSING, ERR_READ_ERROR, FwdState::fail(), Comm::Connection::fd, CommCommonCbParams::flag, flags, StoreEntry::flags, Client::fwd, HttpRequest::hier, IoStats::Http, StatCounters::http, inBuf, Comm::INPROGRESS, IOStats, Comm::IsConnOpen(), SBuf::isEmpty(), maybeMakeSpaceAvailable(), maybeReadVirginBody(), StoreEntry::mem_obj, MemObject::mostBytesAllowed(), Must, AsyncJob::mustStop(), HierarchyLogEntry::notePeerRead(), Comm::OK, payloadSeen, processReply(), IoStats::read_hist, Comm::ReadNow(), IoStats::reads, Client::request, FwdState::request, Http::scBadGateway, StatCounters::server, serverConnection, CommIoCbParams::size, SBuf::spaceSize(), statCounter, CommCommonCbParams::xerrno, and xstrerr().

Referenced by maybeReadVirginBody().

◆ replyBodySpace()

size_t Client::replyBodySpace	(	const MemBuf &	readBuf,
		const size_t	minSpace
	)		const

protectedinherited

Deprecated:: use SBuf I/O API and calcBufferSpaceToReserve() instead

Definition at line 1098 of file Client.cc.

References BodyPipe::buf(), debugs, min(), NULL, MemBuf::potentialSpaceSize(), Client::responseBodyBuffer, MemBuf::spaceSize(), and Client::virginBodyDestination.

◆ requestBodyHandler()

void HttpStateData::requestBodyHandler ( MemBuf & )

private

◆ resumeBodyStorage()

void Client::resumeBodyStorage ( )

protectedinherited

Definition at line 752 of file Client.cc.

References Client::abortOnBadEntry(), Client::adaptedBodySource, Client::endAdaptedBodyConsumption(), BodyPipe::exhausted(), Client::handleMoreAdaptedBodyAvailable(), and NULL.

Referenced by Client::handleMoreAdaptedBodyAvailable().

◆ reusableReply()

HttpStateData::ReuseDecision::Answers HttpStateData::reusableReply ( HttpStateData::ReuseDecision & decision )

Definition at line 294 of file http.cc.

References HttpStateData::ReuseDecision::answer, RequestFlags::auth, RequestFlags::authSent, Http::Message::cache_control, HttpStateData::ReuseDecision::cacheNegatively, HttpStateData::ReuseDecision::cachePositively, Config, Http::CONTENT_TYPE, HttpReply::date, debugs, HttpStateData::ReuseDecision::doNotCacheButShare, EBIT_TEST, Client::entry, HttpReply::expires, Client::finalReply(), HttpRequest::flags, StoreEntry::flags, HttpHeader::getStr(), HttpHdrCc::hasMustRevalidate(), HttpHdrCc::hasNoCacheWithoutParameters(), HttpHdrCc::hasNoCacheWithParameters(), HttpHdrCc::hasNoStore(), HttpHdrCc::hasPrivate(), HttpHdrCc::hasPublic(), HttpHdrCc::hasSMaxAge(), Http::Message::header, ignoreCacheControl, HttpStateData::ReuseDecision::make(), SquidConfig::negativeTtl, NULL, REFRESH_OVERRIDE, refreshIsCachable(), RELEASE_REQUEST, Client::request, HttpStateData::ReuseDecision::reuseNot, sawDateGoBack, Http::scBadGateway, Http::scBadRequest, Http::scConflict, Http::scContentTooLarge, Http::scExpectationFailed, Http::scFailedDependency, Http::scForbidden, Http::scFound, Http::scGatewayTimeout, Http::scGone, Http::scHeaderTooLarge, Http::scInsufficientStorage, Http::scInternalServerError, Http::scInvalidHeader, Http::scLengthRequired, Http::scLocked, Http::scMethodNotAllowed, Http::scMisdirectedRequest, Http::scMovedPermanently, Http::scMultipleChoices, Http::scNoContent, Http::scNonAuthoritativeInformation, Http::scNotAcceptable, Http::scNotFound, Http::scNotImplemented, Http::scNotModified, Http::scOkay, Http::scPartialContent, Http::scPaymentRequired, Http::scPermanentRedirect, Http::scPreconditionFailed, Http::scProxyAuthenticationRequired, Http::scRequestedRangeNotSatisfied, Http::scRequestTimeout, Http::scSeeOther, Http::scServiceUnavailable, Http::scTemporaryRedirect, Http::scUnauthorized, Http::scUnprocessableEntity, Http::scUnsupportedMediaType, Http::scUriTooLong, Http::scUseProxy, HttpReply::sline, Http::StatusLine::status(), and surrogateNoStore.

Referenced by haveParsedReplyHeaders().

◆ sendBodyIsTooLargeError()

void Client::sendBodyIsTooLargeError ( )

privateinherited

Definition at line 985 of file Client.cc.

References Client::abortOnData(), FwdState::al, FwdState::dontRetry(), ERR_TOO_BIG, FwdState::fail(), Client::fwd, RefCount< C >::getRaw(), Client::request, and Http::scForbidden.

Referenced by Client::noteAdaptationAclCheckDone().

◆ sendComplete()

void HttpStateData::sendComplete ( )

private

Definition at line 1673 of file http.cc.

References commSetConnTimeout(), Config, flags, httpTimeout(), JobCallback, SquidConfig::read, Http::StateFlags::request_sent, serverConnection, and SquidConfig::Timeout.

Referenced by doneSendingRequestBody(), and wroteLast().

◆ sendMoreRequestBody()

void Client::sendMoreRequestBody ( )

protectedinherited

Definition at line 412 of file Client.cc.

References assert, conn, MemBuf::contentSize(), Client::dataConnection(), debugs, Client::getMoreRequestBody(), Comm::IsConnOpen(), JobCallback, NULL, Client::requestBodySource, Client::requestSender, Client::sentRequestBody(), and Comm::Write().

Referenced by Client::handleMoreRequestBodyAvailable(), and Client::sentRequestBody().

◆ sendRequest()

bool HttpStateData::sendRequest ( )

Definition at line 2328 of file http.cc.

References _peer, CachePeer::allow_miss, assert, Http::Message::body_pipe, MemBuf::buf, buildRequestPrefix(), Http::StateFlags::chunked_request, closeHandler, commSetConnTimeout(), Config, Http::Message::content_length, debugs, Http::StateFlags::do_next_read, flags, HttpRequest::flags, CachePeer::front_end_https, Http::StateFlags::front_end_https, CachePeer::host, httpTimeout(), MemBuf::init(), Comm::IsConnOpen(), JobCallback, Http::StateFlags::keepalive, SquidConfig::lifetime, maybeReadVirginBody(), Must, RequestFlags::mustKeepalive, CachePeer::n_keepalives_recv, CachePeer::n_keepalives_sent, neighborType(), NULL, Http::StateFlags::only_if_cached, SquidConfig::onoff, CachePeer::options, HttpRequest::peer_host, PEER_SIBLING, Http::Message::persistent(), RequestFlags::pinned, Client::request, Client::requestBodySource, Client::requestSender, sentRequestBody(), SquidConfig::server_pconns, serverConnection, RequestFlags::sslBumped, Client::startRequestBodyFlow(), CachePeer::stats, SquidConfig::Timeout, Http::StateFlags::tunneling, HttpRequest::url, Comm::Write(), and wroteLast().

Referenced by start().

◆ sentRequestBody()

void HttpStateData::sentRequestBody ( const CommIoCbParams & io )

privatevirtual

Implements Client.

Definition at line 2596 of file http.cc.

References StatCounters::http, Client::sentRequestBody(), StatCounters::server, CommIoCbParams::size, and statCounter.

Referenced by sendRequest().

◆ serverComplete()

void Client::serverComplete ( )

inherited

call when no server communication is expected

Definition at line 180 of file Client.cc.

References assert, Client::closeServer(), Client::completed, debugs, Client::doneWithServer(), HttpRequest::hier, NULL, Client::originalRequest(), Client::requestBodySource, Client::responseBodyBuffer, Client::serverComplete2(), BodyConsumer::stopConsumingFrom(), and HierarchyLogEntry::stopPeerClock().

Referenced by ftpReadQuit(), processReplyBody(), and Ftp::Relay::serverComplete().

◆ serverComplete2()

void Client::serverComplete2 ( )

privateinherited

Continuation of serverComplete

Definition at line 202 of file Client.cc.

References Client::completeForwarding(), debugs, Client::doneWithAdaptation(), NULL, BodyProducer::stopProducingFor(), and Client::virginBodyDestination.

Referenced by Client::noteMoreBodySpaceAvailable(), and Client::serverComplete().

◆ setFinalReply()

HttpReply * Client::setFinalReply ( HttpReply * r )

protectedinherited

Definition at line 136 of file Client.cc.

References FwdState::al, assert, Client::blockCaching(), debugs, EBIT_TEST, Client::entry, StoreEntry::flags, Client::fwd, Client::haveParsedReplyHeaders(), HTTPMSGLOCK(), StoreEntry::release(), RELEASE_REQUEST, StoreEntry::replaceHttpReply(), AccessLogEntry::reply, StoreEntry::startWriting(), and Client::theFinalReply.

Referenced by Client::adaptOrFinalizeReply(), Client::handleAdaptedHeader(), and Client::noteAdaptationAclCheckDone().

◆ setVirginReply()

HttpReply * Client::setVirginReply ( HttpReply * r )

protectedinherited

Definition at line 116 of file Client.cc.

References FwdState::al, assert, debugs, Client::fwd, HTTPMSGLOCK(), AccessLogEntry::reply, and Client::theVirginReply.

Referenced by processReplyHeader().

◆ start()

void HttpStateData::start ( )

privatevirtual

Reimplemented from AsyncJob.

Definition at line 2456 of file http.cc.

References StatCounters::all, debugs, StatCounters::http, AsyncJob::mustStop(), sendRequest(), StatCounters::server, and statCounter.

◆ Start()

void AsyncJob::Start ( const Pointer & job )

staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 24 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ startAdaptation()

void Client::startAdaptation	(	const Adaptation::ServiceGroupPointer &	group,
		HttpRequest *	cause
	)

protectedinherited

Definition at line 578 of file Client.cc.

References Client::adaptedHeadSource, FwdState::al, assert, Http::Message::body_pipe, debugs, HttpReply::expectingBody(), Client::fwd, Adaptation::Initiator::initiateAdaptation(), Adaptation::Initiator::initiated(), HttpRequest::method, Must, BodyPipe::setBodySize(), size, Client::startedAdaptation, Client::virginBodyDestination, and Client::virginReply().

Referenced by Client::noteAdaptationAclCheckDone().

◆ startRequestBodyFlow()

bool Client::startRequestBodyFlow ( )

protectedinherited

Definition at line 239 of file Client.cc.

References assert, Http::Message::body_pipe, debugs, NULL, Client::originalRequest(), Client::requestBodySource, BodyPipe::setConsumerIfNotLate(), and BodyPipe::status().

Referenced by sendRequest().

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in HappyConnOpener, Security::PeerConnector, Ipc::Inquirer, Comm::TcpAcceptor, Http::Tunneler, Adaptation::Initiate, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, and Adaptation::Ecap::XactionRep.

Definition at line 167 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Adaptation::Initiate::status(), and Comm::TcpAcceptor::status().

◆ statusIfComplete()

HttpStateData::ConnectionStatus HttpStateData::statusIfComplete ( ) const

private

: If the reply wants to close the connection, it takes precedence

: If we sent a Connection:close request header, then this can not be a persistent connection.

: If we banned reuse, then this cannot be a persistent connection.

: If we haven't sent the whole request then this can not be a persistent connection.

: What does the reply have to say about keep-alive?

Bug:: XXX BUG? If the origin server (HTTP/1.0) does not send a keep-alive header, but keeps the connection open anyway, what happens? We'll return here and http.c waits for an EOF before changing store_status to STORE_OK. Combine this with ENTRY_FWD_HDR_WAIT and an error status code, and we might have to wait until the server times out the socket.

Definition at line 1067 of file http.cc.

References COMPLETE_NONPERSISTENT_MSG, COMPLETE_PERSISTENT_MSG, debugs, Client::entry, flags, Http::StateFlags::forceClose, Http::Message::header, httpHeaderHasConnDir(), HttpReply::keep_alive, Http::StateFlags::keepalive, HttpRequest::method, Client::request, Http::StateFlags::request_sent, StoreEntry::url(), and Client::virginReply().