#include <HttpRequest.h>

Inheritance diagram for HttpRequest:

Collaboration diagram for HttpRequest:

[legend]

Public Types
typedef RefCount< HttpRequest >	Pointer

enum	Sources { srcUnknown = 0, srcHttps = 1 << 0, srcFtps = 1 << 1, srcIcaps = 1 << 2, srcEcaps = 1 << 3, srcHttp = 1 << (16 + 0), srcFtp = 1 << (16 + 1), srcIcap = 1 << (16 + 2), srcEcap = 1 << (16 + 3), srcGopher = 1 << (16 + 14), srcWhois = 1 << (16 + 15), srcUnsafe = 0xFFFF0000, srcSafe = 0x0000FFFF }
	Who may have created or modified this message? More...

enum	ParseState { psReadyToParseStartLine = 0, psReadyToParseHeaders, psParsed, psError }
	parse state of HttpReply or HttpRequest More...

Public Member Functions
void *	operator new (size_t byteCount)

void	operator delete (void *address)

	HttpRequest (const MasterXaction::Pointer &)

	HttpRequest (const HttpRequestMethod &aMethod, AnyP::ProtocolType aProtocol, const char schemeImage, const char aUrlpath, const MasterXaction::Pointer &)

	~HttpRequest ()

virtual void	reset ()

void	initHTTP (const HttpRequestMethod &aMethod, AnyP::ProtocolType aProtocol, const char schemeImage, const char aUrlpath)

virtual HttpRequest *	clone () const

bool	maybeCacheable ()

bool	conditional () const
	has at least one recognized If-* header More...

bool	canHandle1xx () const
	whether the client is likely to be able to handle a 1xx reply More...

char *	canonicalCleanUrl () const

Adaptation::History::Pointer	adaptLogHistory () const
	Returns possibly nil history, creating it if adapt. logging is enabled. More...

Adaptation::History::Pointer	adaptHistory (bool createIfNone=false) const
	Returns possibly nil history, creating it if requested. More...

void	adaptHistoryImport (const HttpRequest &them)
	Makes their history ours, throwing on conflicts. More...

Adaptation::Icap::History::Pointer	icapHistory () const
	Returns possibly nil history, creating it if icap logging is enabled. More...

void	prepForPeering (const CachePeer &peer)
	get ready to be sent to the given cache_peer, including originserver More...

void	prepForDirect ()
	get ready to be sent directly to an origin server, excluding originserver More...

void	recordLookup (const Dns::LookupDetails &detail)

void	detailError (err_type aType, int aDetail)
	sets error detail if no earlier detail was available More...

void	clearError ()
	clear error details, useful for retries/repeats More...

void	manager (const CbcPointer< ConnStateData > &aMgr, const AccessLogEntryPointer &al)
	associates the request with a from-client connection manager More...

const SBuf &	effectiveRequestUri () const
	RFC 7230 section 5.5 - Effective Request URI. More...

bool	multipartRangeRequest () const

bool	parseFirstLine (const char start, const char end)

virtual bool	expectingBody (const HttpRequestMethod &unused, int64_t &) const

bool	bodyNibbled () const

int	prefixLen () const

void	swapOut (StoreEntry *e)

void	pack (Packable *p) const

ConnStateData *	pinnedConnection ()

const SBuf	storeId ()

void	ignoreRange (const char *reason)
	forgets about the cached Range header (for a reason) More...

int64_t	getRangeOffsetLimit ()

NotePairs::Pointer	notes ()

bool	hasNotes () const

virtual void	configureContentLengthInterpreter (Http::ContentLengthInterpreter &)
	configures the interpreter as needed More...

bool	parseHeader (Http1::Parser &hp)

bool	parseHeader (const char *buffer, const size_t size)

void	packInto (Packable *, bool full_uri) const
	produce a message copy, except for a few connection-specific settings More...

void	setContentLength (int64_t)
	[re]sets Content-Length header and cached value More...

bool	persistent () const

void	putCc (const HttpHdrCc *otherCc)
	copies Cache-Control header to this message More...

bool	parse (const char buf, const size_t sz, bool eol, Http::StatusCode error)

bool	parseCharBuf (const char *buf, ssize_t end)

int	httpMsgParseStep (const char *buf, int len, int atEnd)

virtual int	httpMsgParseError ()

void	firstLineBuf (MemBuf &)
	useful for debugging More...

Static Public Member Functions
static int	UseCount ()

static void	httpRequestPack (void obj, Packable p)

static HttpRequest *	FromUrl (const char *url, const MasterXaction::Pointer &, const HttpRequestMethod &method=Http::METHOD_GET)

Public Attributes
HttpRequestMethod	method

AnyP::Uri	url
	the request URI More...

Auth::UserRequest::Pointer	auth_user_request

String	store_id

RequestFlags	flags

HttpHdrRange *	range

time_t	ims

int	imslen

Ip::Address	client_addr

Ip::Address	indirect_client_addr

Ip::Address	my_addr

HierarchyLogEntry	hier

int	dnsWait
	sum of DNS lookup delays in milliseconds, for dt More...

err_type	errType

int	errDetail
	errType-specific detail about the transaction error More...

char *	peer_login

char *	peer_host

time_t	lastmod

SBuf	vary_headers
	The variant second-stage cache key. Generated from Vary header pattern for this request. More...

char *	peer_domain

String	myportname

String	tag

String	extacl_user

String	extacl_passwd

String	extacl_log

String	extacl_message

String	x_forwarded_for_iterator

String	etag
	A strong etag of the cached entry. Used for refreshing that entry. More...

bool	forcedBodyContinuation
	whether we have responded with HTTP 100 or FTP 150 already More...

CbcPointer< ConnStateData >	clientConnectionManager

CbcPointer< Downloader >	downloader
	The Downloader object which initiated the HTTP request if any. More...

MasterXaction::Pointer	masterXaction
	the master transaction this request belongs to. Never nil. More...

AnyP::ProtocolVersion	http_ver

HttpHeader	header

HttpHdrCc *	cache_control = nullptr

int	hdr_sz = 0

int64_t	content_length = 0

ParseState	pstate = Http::Message::psReadyToParseStartLine
	the current parsing state More...

BodyPipe::Pointer	body_pipe
	optional pipeline to receive message body More...

uint32_t	sources = 0
	The message sources. More...

Protected Member Functions
void	clean ()

void	init ()

virtual void	packFirstLineInto (Packable *p, bool full_uri) const

virtual bool	sanityCheckStartLine (const char buf, const size_t hdr_len, Http::StatusCode error)

virtual void	hdrCacheInit ()

virtual bool	inheritProperties (const Http::Message *)

bool	parseHeader (Http1::Parser &, Http::ContentLengthInterpreter &)

Static Private Member Functions
static Mem::AllocatorProxy &	Pool ()

Private Attributes
Adaptation::History::Pointer	adaptHistory_
	per-HTTP transaction info More...

Adaptation::Icap::History::Pointer	icapHistory_
	per-HTTP transaction info More...

int64_t	rangeOffsetLimit

NotePairs::Pointer	theNotes

Detailed Description

Definition at line 48 of file HttpRequest.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<HttpRequest> HttpRequest::Pointer

Definition at line 50 of file HttpRequest.h.

Member Enumeration Documentation

◆ ParseState

enum Http::Message::ParseState

inherited

Enumerator
psReadyToParseStartLine
psReadyToParseHeaders
psParsed
psError

Definition at line 87 of file Message.h.

◆ Sources

enum Http::Message::Sources

inherited

Enumerator
srcUnknown
srcHttps	https_port or bumped http_port tunnel; HTTPS server
srcFtps	ftps_port or SFTP server; currently unused
srcIcaps	Secure ICAP service.
srcEcaps	eCAP service that is considered secure; currently unused
srcHttp	http_port or HTTP server
srcFtp	ftp_port or FTP server
srcIcap	traditional ICAP service without encryption
srcEcap	eCAP service that uses insecure libraries/daemons
srcGopher	Gopher server.
srcWhois	Whois server.
srcUnsafe	Unsafe sources mask.
srcSafe	Safe sources mask.

Definition at line 29 of file Message.h.

Constructor & Destructor Documentation

◆ HttpRequest() [1/2]

HttpRequest::HttpRequest ( const MasterXaction::Pointer & mx )

Definition at line 43 of file HttpRequest.cc.

References assert, and init().

Referenced by clone(), and FromUrl().

◆ HttpRequest() [2/2]

HttpRequest::HttpRequest	(	const HttpRequestMethod &	aMethod,
		AnyP::ProtocolType	aProtocol,
		const char *	schemeImage,
		const char *	aUrlpath,
		const MasterXaction::Pointer &	mx
	)

Definition at line 51 of file HttpRequest.cc.

References assert, debugs, HERE(), init(), and initHTTP().

◆ ~HttpRequest()

HttpRequest::~HttpRequest ( )

Definition at line 62 of file HttpRequest.cc.

References clean(), debugs, and HERE().

Member Function Documentation

◆ adaptHistory()

Adaptation::History::Pointer HttpRequest::adaptHistory ( bool createIfNone = false ) const

Definition at line 415 of file HttpRequest.cc.

References adaptHistory_, debugs, and HERE().

Referenced by adaptLogHistory(), Format::Format::assemble(), inheritProperties(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Ecap::XactionRep::masterxSharedValue(), ACLAdaptationServiceStrategy::match(), Adaptation::Icap::ModXact::parseIcapHead(), Adaptation::Iterator::start(), Adaptation::Iterator::step(), Adaptation::Ecap::XactionRep::updateHistory(), Adaptation::Iterator::updatePlan(), Adaptation::AccessCheck::usedDynamicRules(), and Ftp::Server::writeErrorReply().

◆ adaptHistoryImport()

void HttpRequest::adaptHistoryImport ( const HttpRequest & them )

Definition at line 432 of file HttpRequest.cc.

References adaptHistory_, and Must.

◆ adaptLogHistory()

Adaptation::History::Pointer HttpRequest::adaptLogHistory ( ) const

Definition at line 426 of file HttpRequest.cc.

References adaptHistory(), and Log::TheConfig.

Referenced by Adaptation::Icap::ModXact::parseIcapHead(), prepareLogWithRequestDetails(), Adaptation::Ecap::XactionRep::start(), Adaptation::Icap::ModXact::start(), Adaptation::Ecap::XactionRep::swanSong(), Adaptation::Icap::ModXact::swanSong(), and Adaptation::Ecap::XactionRep::updateHistory().

◆ bodyNibbled()

bool HttpRequest::bodyNibbled ( ) const

Definition at line 451 of file HttpRequest.cc.

References Http::Message::body_pipe, BodyPipe::consumedSize(), and NULL.

Referenced by FwdState::checkRetry(), and FwdState::reforward().

◆ canHandle1xx()

bool HttpRequest::canHandle1xx ( ) const

Definition at line 662 of file HttpRequest.cc.

References Http::EXPECT, HttpHeader::has(), Http::Message::header, Http::Message::http_ver, and Http::ProtocolVersion().

Referenced by HttpStateData::handle1xx().

◆ canonicalCleanUrl()

char * HttpRequest::canonicalCleanUrl ( ) const

Returns: a pointer to a local static buffer containing request URI that honors strip_query_terms and %-encodes unsafe URI characters

Definition at line 777 of file HttpRequest.cc.

References effectiveRequestUri(), AnyP::Uri::getScheme(), method, url, and urlCanonicalCleanWithoutRequest().

Referenced by ClientHttpRequest::setLogUriToRequestUri(), and urlCanonicalFakeHttps().

◆ clean()

void HttpRequest::clean ( )

protected

Definition at line 123 of file HttpRequest.cc.

References adaptHistory_, auth_user_request, Http::Message::body_pipe, Http::Message::cache_control, HttpHeader::clean(), String::clean(), AnyP::Uri::clear(), SBuf::clear(), etag, extacl_log, extacl_message, extacl_passwd, extacl_user, Http::Message::header, icapHistory_, myportname, NULL, range, tag, theNotes, url, and vary_headers.

Referenced by reset(), and ~HttpRequest().

◆ clearError()

void HttpRequest::clearError ( )

Definition at line 490 of file HttpRequest.cc.

References debugs, ERR_DETAIL_NONE, ERR_NONE, errDetail, errType, and HERE().

Referenced by Adaptation::Icap::ModXact::clearError(), FwdState::connectStart(), and Adaptation::Iterator::step().

◆ clone()

HttpRequest * HttpRequest::clone ( ) const

virtual

Implements Http::Message.

Definition at line 177 of file HttpRequest.cc.

References HttpHeader::append(), assert, Http::Message::body_pipe, errType, etag, extacl_log, extacl_message, Http::Message::hdr_sz, hdrCacheInit(), Http::Message::header, hier, Http::Message::http_ver, HttpRequest(), ims, imslen, inheritProperties(), lastmod, masterXaction, method, Http::Message::pstate, tag, url, and vary_headers.

Referenced by ClientRequestContext::clientRedirectDone().

◆ conditional()

bool HttpRequest::conditional ( ) const

Definition at line 599 of file HttpRequest.cc.

References flags, HttpHeader::has(), Http::Message::header, Http::IF_MATCH, Http::IF_NONE_MATCH, and RequestFlags::ims.

Referenced by clientReplyContext::cacheHit().

◆ configureContentLengthInterpreter()

virtual void HttpRequest::configureContentLengthInterpreter ( Http::ContentLengthInterpreter & )

inlinevirtual

Implements Http::Message.

Definition at line 247 of file HttpRequest.h.

References parseHeader(), and size.

◆ detailError()

void HttpRequest::detailError	(	err_type	aType,
		int	aDetail
	)

Definition at line 476 of file HttpRequest.cc.

References debugs, errDetail, errType, and HERE().

Referenced by ErrorState::BuildHttpReply(), Adaptation::Icap::ModXact::detailError(), Ftp::Client::failed(), Ftp::Relay::failedErrorMessage(), ClientHttpRequest::handleAdaptationBlock(), Client::handleAdaptationBlocked(), Client::handledEarlyAdaptationAbort(), ClientHttpRequest::noteBodyProducerAborted(), and ConnStateData::serveDelayedError().

◆ effectiveRequestUri()

const SBuf & HttpRequest::effectiveRequestUri ( ) const

Definition at line 707 of file HttpRequest.cc.

References AnyP::Uri::absolute(), AnyP::Uri::authority(), AnyP::Uri::getScheme(), HttpRequestMethod::id(), method, Http::METHOD_CONNECT, AnyP::PROTO_AUTHORITY_FORM, and url.

Referenced by Format::Format::assemble(), HttpStateData::buildRequestPrefix(), canonicalCleanUrl(), carpSelectParent(), ClientRequestContext::clientRedirectDone(), ErrorState::compileLegacyCode(), AccessLogEntry::effectiveVirginUrl(), ClientHttpRequest::handleAdaptedHeader(), HttpStateData::httpBuildRequestHeader(), ACLUrlStrategy::match(), Client::maybePurgeOthers(), packFirstLineInto(), clientReplyContext::purgeAllCached(), clientReplyContext::purgeDoPurgeHead(), refreshCheck(), ClientHttpRequest::resetRequest(), Ssl::ServerBump::ServerBump(), storeId(), Adaptation::Ecap::RequestLineRep::uri(), PeerSelector::url(), Ftp::UrlWith2f(), and ACLFilledChecklist::verifyAle().

◆ expectingBody()

bool HttpRequest::expectingBody	(	const HttpRequestMethod &	unused,
		int64_t &	theSize
	)		const

virtual

Implements Http::Message.

Definition at line 514 of file HttpRequest.cc.

References HttpHeader::chunked(), Http::Message::content_length, and Http::Message::header.

◆ firstLineBuf()

void Http::Message::firstLineBuf ( MemBuf & mb )

inherited

Definition at line 295 of file Message.cc.

References Http::Message::packFirstLineInto().

◆ FromUrl()

HttpRequest * HttpRequest::FromUrl	(	const char *	url,
		const MasterXaction::Pointer &	mx,
		const HttpRequestMethod &	method = `Http::METHOD_GET`
	)

static

◆ getRangeOffsetLimit()

int64_t HttpRequest::getRangeOffsetLimit ( )

Definition at line 621 of file HttpRequest.cc.

References Acl::Answer::allowed(), client_addr, Config, debugs, ACLChecklist::fastCheck(), ACLFilledChecklist::my_addr, my_addr, NULL, rangeOffsetLimit, SquidConfig::rangeOffsetLimit, and ACLFilledChecklist::src_addr.

Referenced by Http::Stream::buildRangeHeader(), CheckQuickAbortIsReasonable(), and HttpStateData::decideIfWeDoRanges().

◆ hasNotes()

bool HttpRequest::hasNotes ( ) const

inline

Definition at line 245 of file HttpRequest.h.

References NotePairs::empty(), and theNotes.

Referenced by Http::One::Server::buildHttpRequest().

◆ hdrCacheInit()

void HttpRequest::hdrCacheInit ( )

protectedvirtual

Reimplemented from Http::Message.

Definition at line 390 of file HttpRequest.cc.

References assert, HttpHeader::getRange(), Http::Message::hdrCacheInit(), Http::Message::header, and range.

Referenced by clone().

◆ httpMsgParseError()

int Http::Message::httpMsgParseError ( )

virtualinherited

Reimplemented in HttpReply.

Definition at line 246 of file Message.cc.

References Http::Message::reset().

Referenced by HttpReply::httpMsgParseError(), and Http::Message::httpMsgParseStep().

◆ httpMsgParseStep()

int Http::Message::httpMsgParseStep	(	const char *	buf,
		int	len,
		int	atEnd
	)

inherited

parses a 0-terminated buffer into Http::Message.

Return values

1	success
0	need more data (partial parse)
-1	parse error

Definition at line 170 of file Message.cc.

References assert, buf, Http::Message::configureContentLengthInterpreter(), Http::Message::hdr_sz, Http::Message::hdrCacheInit(), Http::Message::header, httpMsgIsolateStart(), Http::Message::httpMsgParseError(), len, HttpHeader::parse(), Http::Message::parseFirstLine(), PROF_start, PROF_stop, Http::Message::psParsed, Http::Message::psReadyToParseHeaders, Http::Message::psReadyToParseStartLine, and Http::Message::pstate.

Referenced by MemStore::copyFromShmSlice(), Http::Message::parse(), and Http::Message::parseCharBuf().

◆ httpRequestPack()

static void HttpRequest::httpRequestPack	(	void *	obj,
		Packable *	p
	)

static

◆ icapHistory()

Adaptation::Icap::History::Pointer HttpRequest::icapHistory ( ) const

Definition at line 400 of file HttpRequest.cc.

References debugs, HERE(), icapHistory_, IcapLogfileStatus, LOG_ENABLE, and Log::TheConfig.

Referenced by Adaptation::AccessCheck::AccessCheck(), ClientHttpRequest::doCallouts(), Adaptation::Icap::ModXact::finalizeLogInfo(), inheritProperties(), ClientHttpRequest::noteAdaptationAclCheckDone(), prepareLogWithRequestDetails(), Adaptation::Icap::ModXactLauncher::updateHistory(), and Adaptation::AccessCheck::~AccessCheck().

◆ ignoreRange()

void HttpRequest::ignoreRange ( const char * reason )

Definition at line 648 of file HttpRequest.cc.

References debugs, NULL, and range.

Referenced by Http::Stream::buildRangeHeader(), clientInterpretRequestHeaders(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::setReplyToError(), clientReplyContext::setReplyToReply(), and clientReplyContext::setReplyToStoreEntry().

◆ inheritProperties()

bool HttpRequest::inheritProperties ( const Http::Message * aMsg )

protectedvirtual

Implements Http::Message.

Definition at line 216 of file HttpRequest.cc.

References adaptHistory(), adaptHistory_, auth_user_request, client_addr, clientConnectionManager, RequestFlags::cloneAdaptationImmune(), dnsWait, downloader, errDetail, errType, extacl_passwd, extacl_user, flags, forcedBodyContinuation, icapHistory(), icapHistory_, indirect_client_addr, my_addr, myportname, Http::Message::sources, and theNotes.

Referenced by clone().

◆ init()

void HttpRequest::init ( void )

protected

Definition at line 77 of file HttpRequest.cc.

References adaptHistory_, auth_user_request, Http::Message::body_pipe, AnyP::Uri::clear(), client_addr, dnsWait, ERR_DETAIL_NONE, ERR_NONE, errDetail, errType, extacl_log, extacl_message, extacl_passwd, extacl_user, flags, forcedBodyContinuation, icapHistory_, ims, imslen, indirect_client_addr, lastmod, method, Http::METHOD_NONE, my_addr, myportname, NULL, null_string, peer_domain, peer_host, peer_login, Http::Message::psReadyToParseStartLine, Http::Message::pstate, range, rangeOffsetLimit, Ip::Address::setEmpty(), tag, url, and vary_headers.

Referenced by HttpRequest(), and reset().

◆ initHTTP()

void HttpRequest::initHTTP	(	const HttpRequestMethod &	aMethod,
		AnyP::ProtocolType	aProtocol,
		const char *	schemeImage,
		const char *	aUrlpath
	)

Definition at line 69 of file HttpRequest.cc.

References method, AnyP::Uri::path(), AnyP::Uri::setScheme(), and url.

Referenced by HttpRequest().

◆ manager()

void HttpRequest::manager	(	const CbcPointer< ConnStateData > &	aMgr,
		const AccessLogEntryPointer &	al
	)

◆ maybeCacheable()

bool HttpRequest::maybeCacheable ( )

Whether response to this request is potentially cachable

Return values

false	Not cacheable.
true	Possibly cacheable. Response factors will determine.

Are responses to this request possible cacheable ? If false then no matter what the response must not be cached.

Definition at line 558 of file HttpRequest.cc.

References Http::Message::cache_control, flags, AnyP::Uri::getScheme(), gopherCachable(), HttpHdrCc::hasNoStore(), RequestFlags::hostVerified, RequestFlags::ignoreCc, RequestFlags::intercepted, RequestFlags::interceptTproxy, method, AnyP::PROTO_CACHE_OBJECT, AnyP::PROTO_GOPHER, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, HttpRequestMethod::respMaybeCacheable(), and url.

Referenced by clientInterpretRequestHeaders().

◆ multipartRangeRequest()

bool HttpRequest::multipartRangeRequest ( ) const

Definition at line 445 of file HttpRequest.cc.

References range, and HttpHdrRange::specs.

Referenced by clientReplyContext::buildReplyHeader(), and HttpStateData::httpBuildRequestHeader().

◆ notes()

NotePairs::Pointer HttpRequest::notes ( )

Returns: existing non-empty transaction annotations, creates and returns empty annotations otherwise

Definition at line 715 of file HttpRequest.cc.

References theNotes.

Referenced by Http::One::Server::buildHttpRequest(), ClientHttpRequest::initRequest(), AccessLogEntry::syncNotes(), and UpdateRequestNotes().

◆ operator delete()

void HttpRequest::operator delete ( void * address )

inline

Definition at line 50 of file HttpRequest.h.

◆ operator new()

void* HttpRequest::operator new ( size_t byteCount )

inline

Definition at line 50 of file HttpRequest.h.

◆ pack()

void HttpRequest::pack ( Packable * p ) const

Definition at line 355 of file HttpRequest.cc.

References Packable::append(), Packable::appendf(), assert, Http::Message::header, Http::Message::http_ver, HttpRequestMethod::image(), AnyP::ProtocolVersion::major, method, AnyP::ProtocolVersion::minor, HttpHeader::packInto(), AnyP::Uri::path(), SQUIDSBUFPH, SQUIDSBUFPRINT, and url.

Referenced by Ftp::Server::handleRequest(), httpRequestPack(), and swapOut().

◆ packFirstLineInto()

void HttpRequest::packFirstLineInto	(	Packable *	p,
		bool	full_uri
	)		const

protectedvirtual

Implements Http::Message.

Definition at line 498 of file HttpRequest.cc.

References Packable::appendf(), effectiveRequestUri(), Http::Message::http_ver, HttpRequestMethod::image(), AnyP::ProtocolVersion::major, method, AnyP::ProtocolVersion::minor, AnyP::Uri::path(), SQUIDSBUFPH, SQUIDSBUFPRINT, and url.

◆ packInto()

void Http::Message::packInto	(	Packable *	p,
		bool	full_uri
	)		const

inherited

Definition at line 278 of file Message.cc.

References Packable::append(), Http::Message::header, Http::Message::packFirstLineInto(), and HttpHeader::packInto().

Referenced by Adaptation::Ecap::HeaderRep::image(), and Adaptation::Icap::ModXact::packHead().

◆ parse()

bool Http::Message::parse	(	const char *	buf,
		const size_t	sz,
		bool	eol,
		Http::StatusCode *	error
	)

inherited

Definition at line 80 of file Message.cc.

References assert, Config, DBG_IMPORTANT, debugs, Http::Message::hdr_sz, headersEnd(), Http::Message::httpMsgParseStep(), int, SquidConfig::maxReplyHeaderSize, Http::Message::sanityCheckStartLine(), Http::scHeaderTooLarge, Http::scInvalidHeader, and Http::scNone.

Referenced by Adaptation::Icap::OptXact::makeRequest(), Adaptation::Ecap::HeaderRep::parse(), Adaptation::Icap::Xaction::parseHttpMsg(), and Adaptation::Icap::ModXact::prepEchoing().

◆ parseCharBuf()

bool Http::Message::parseCharBuf	(	const char *	buf,
		ssize_t	end
	)

inherited

parseCharBuf() takes character buffer of HTTP headers (buf), which may not be NULL-terminated, and fills in an Http::Message structure. The parameter 'end' specifies the offset to the end of the reply headers. The caller may know where the end is, but is unable to NULL-terminate the buffer. This function returns true on success.

Definition at line 148 of file Message.cc.

References MemBuf::append(), MemBuf::buf, MemBuf::clean(), Http::Message::httpMsgParseStep(), MemBuf::init(), Http::Message::reset(), MemBuf::size, and MemBuf::terminate().

Referenced by Adaptation::Icap::ModXact::makeRequestHeaders(), store_client::readBody(), and urnHandleReply().

◆ parseFirstLine()

bool HttpRequest::parseFirstLine	(	const char *	start,
		const char *	end
	)

virtual

Implements Http::Message.

Definition at line 297 of file HttpRequest.cc.

References DBG_IMPORTANT, debugs, findTrailingHTTPVersion(), Http::Message::http_ver, HttpRequestMethod::HttpRequestMethodXXX(), AnyP::ProtocolVersion::major, method, Http::METHOD_NONE, AnyP::ProtocolVersion::minor, AnyP::Uri::parse(), url, w_space, and xisspace.

◆ parseHeader() [1/3]

bool Http::Message::parseHeader	(	Http1::Parser &	hp,
		Http::ContentLengthInterpreter &	clen
	)

protectedinherited

Definition at line 226 of file Message.cc.

References SBuf::c_str(), Http::Message::configureContentLengthInterpreter(), Http::Message::hdr_sz, Http::Message::hdrCacheInit(), Http::Message::header, Http::One::Parser::headerBlockSize(), Http::One::Parser::messageHeaderSize(), Http::One::Parser::mimeHeader(), HttpHeader::parse(), Http::Message::psError, Http::Message::psParsed, and Http::Message::pstate.

◆ parseHeader() [2/3]

bool HttpRequest::parseHeader ( Http1::Parser & hp )

Parses request header using Parser. Use it in contexts where the Parser object is available.

Definition at line 674 of file HttpRequest.cc.

Referenced by Http::One::Server::buildHttpRequest(), configureContentLengthInterpreter(), and htcpClrStore().

◆ parseHeader() [3/3]

bool HttpRequest::parseHeader	(	const char *	buffer,
		const size_t	size
	)

Parses request header from the buffer. Use it in contexts where the Parser object not available.

Definition at line 681 of file HttpRequest.cc.

References Http::Message::header, and HttpHeader::parse().

◆ persistent()

bool Http::Message::persistent ( ) const

inherited

Return values

true	the message sender asks to keep the connection open.
false	the message sender will close the connection.

Factors other than the headers may result in connection closure.

Definition at line 261 of file Message.cc.

References Http::Message::header, Http::Message::http_ver, httpHeaderHasConnDir(), and Http::ProtocolVersion().

Referenced by clientReplyContext::buildReplyHeader(), clientSetKeepaliveFlag(), HttpReply::hdrCacheInit(), and HttpStateData::sendRequest().

◆ pinnedConnection()

ConnStateData * HttpRequest::pinnedConnection ( )

Definition at line 688 of file HttpRequest.cc.

References clientConnectionManager, CbcPointer< Cbc >::get(), NULL, ConnStateData::pinned, ConnStateData::pinning, and CbcPointer< Cbc >::valid().

Referenced by borrowPinnedConnection(), clientReplyContext::buildReplyHeader(), clientCheckPinning(), FwdState::fail(), FwdState::stopAndDestroy(), and FwdState::usePinned().

◆ Pool()

static Mem::AllocatorProxy& HttpRequest::Pool ( )

inlinestaticprivate

Definition at line 50 of file HttpRequest.h.

◆ prefixLen()

int HttpRequest::prefixLen ( ) const

Definition at line 380 of file HttpRequest.cc.

References Http::Message::header, HttpRequestMethod::image(), HttpHeader::len, SBuf::length(), method, AnyP::Uri::path(), and url.

Referenced by peerDigestFetchSetStats(), and clientReplyContext::traceReply().

◆ prepForDirect()

void HttpRequest::prepForDirect ( )

Definition at line 467 of file HttpRequest.cc.

References RequestFlags::auth_no_keytab, debugs, flags, peer_domain, and peer_login.

Referenced by FwdState::dispatch(), switchToTunnel(), and tunnelConnectDone().

◆ prepForPeering()

void HttpRequest::prepForPeering ( const CachePeer & peer )

Definition at line 457 of file HttpRequest.cc.

References RequestFlags::auth_no_keytab, CachePeer::auth_no_keytab, debugs, CachePeer::domain, flags, CachePeer::host, CachePeer::login, CachePeer::options, CachePeer::originserver, peer_domain, and peer_login.

Referenced by FwdState::dispatch(), Http::Tunneler::start(), switchToTunnel(), and tunnelConnectDone().

◆ putCc()

void Http::Message::putCc ( const HttpHdrCc * otherCc )

inherited

Definition at line 34 of file Message.cc.

References Http::CACHE_CONTROL, Http::Message::cache_control, HttpHeader::delById(), Http::Message::header, and HttpHeader::putCc().

Referenced by HttpReply::make304().

◆ recordLookup()

void HttpRequest::recordLookup ( const Dns::LookupDetails & detail )

Definition at line 607 of file HttpRequest.cc.

References debugs, dnsWait, and Dns::LookupDetails::wait.

Referenced by DestinationIPLookup::checkForAsync(), SourceDomainLookup::LookupDone(), and DestinationDomainLookup::LookupDone().

◆ reset()

void HttpRequest::reset ( )

virtual

Implements Http::Message.

Definition at line 170 of file HttpRequest.cc.

References clean(), and init().

◆ sanityCheckStartLine()

bool HttpRequest::sanityCheckStartLine	(	const char *	buf,
		const size_t	hdr_len,
		Http::StatusCode *	error
	)

protectedvirtual

Checks the first line of an HTTP request is valid currently just checks the request method is present.

NP: Other errors are left for detection later in the parse.

Implements Http::Message.

Definition at line 271 of file HttpRequest.cc.

References debugs, HERE(), HttpRequestMethod::HttpRequestMethodXXX(), Http::METHOD_NONE, and Http::scInvalidHeader.

Referenced by PrivateHttpRequest::doSanityCheckStartLine().

◆ setContentLength()

void Http::Message::setContentLength ( int64_t clen )

inherited

Definition at line 253 of file Message.cc.

References Http::CONTENT_LENGTH, Http::Message::content_length, HttpHeader::delById(), Http::Message::header, and HttpHeader::putInt64().

◆ storeId()

const SBuf HttpRequest::storeId ( )

Returns the current StoreID for the request as a nul-terminated char*. Always returns the current id for the request (either the effective request URI or modified ID by the helper).

Definition at line 696 of file HttpRequest.cc.

References debugs, effectiveRequestUri(), String::size(), store_id, and StringToSBuf().

Referenced by clientReplyContext::cacheHit(), ClientHttpRequest::doCallouts(), storeKeyPublicByRequestMethod(), and storeSwapMetaBuild().

◆ swapOut()

void HttpRequest::swapOut ( StoreEntry * e )

Definition at line 345 of file HttpRequest.cc.

References assert, StoreEntry::buffer(), StoreEntry::flush(), and pack().

Referenced by clientReplyContext::traceReply().

◆ UseCount()

static int HttpRequest::UseCount ( )

inlinestatic

Definition at line 50 of file HttpRequest.h.

Member Data Documentation

◆ adaptHistory_

Adaptation::History::Pointer HttpRequest::adaptHistory_

mutableprivate

Definition at line 119 of file HttpRequest.h.

Referenced by adaptHistory(), adaptHistoryImport(), clean(), inheritProperties(), and init().

◆ auth_user_request

Auth::UserRequest::Pointer HttpRequest::auth_user_request

Definition at line 127 of file HttpRequest.h.

Referenced by Format::Format::assemble(), Auth::UserRequest::authenticate(), AuthenticateAcl(), authTryGetUser(), ConnStateData::buildFakeRequest(), clientReplyContext::buildReplyHeader(), ClientHttpRequest::calloutsError(), clean(), clientProcessRequest(), ErrorState::compileLegacyCode(), constructHelperQuery(), DelayId::DelayClient(), Auth::UserRequest::helperRequestKeyExtras(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), httpFixupAuthentication(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeUsernameHeader(), peerUserHashSelectParent(), Log::Format::SquidIcap(), Log::Format::SquidNative(), ClientHttpRequest::sslBumpEstablish(), statClientRequests(), Auth::UserRequest::tryToAuthenticateAndSetAuthUser(), and Adaptation::Ecap::XactionRep::usernameValue().

◆ body_pipe

BodyPipe::Pointer Http::Message::body_pipe

inherited

Definition at line 98 of file Message.h.

Referenced by bodyNibbled(), FwdState::checkRetriable(), clean(), HttpReply::clean(), clientProcessRequest(), ClientRequestContext::clientRedirectDone(), clone(), HttpReply::clone(), Adaptation::Ecap::MessageRep::clone(), FwdState::doneWithRetries(), Adaptation::Icap::ModXact::estimateVirginBody(), Adaptation::Icap::ModXact::finalizeLogInfo(), Adaptation::Iterator::handleAdaptationError(), ClientHttpRequest::handleAdaptationFailure(), Client::handleAdaptedHeader(), init(), Adaptation::Icap::ModXact::makeAdaptedBodyPipe(), Adaptation::Icap::ModXact::prepEchoing(), Adaptation::Icap::ModXact::prepPartialBodyEchoing(), Adaptation::Ecap::XactionRep::preserveVb(), HttpStateData::sendRequest(), Adaptation::Message::set(), Adaptation::Icap::InOut::setHeader(), Adaptation::Message::ShortCircuit(), Adaptation::Ecap::XactionRep::sinkVb(), Client::startAdaptation(), Client::startRequestBodyFlow(), Adaptation::Ecap::MessageRep::tieBody(), Adaptation::Ecap::XactionRep::useAdapted(), Adaptation::Ecap::XactionRep::useVirgin(), and Http::Message::~Message().

◆ cache_control

HttpHdrCc* Http::Message::cache_control = nullptr

inherited

Definition at line 77 of file Message.h.

Referenced by clean(), clientInterpretRequestHeaders(), MimeIcon::created(), HttpReply::hdrCacheClean(), Http::Message::hdrCacheInit(), HttpReply::hdrExpirationTime(), HttpReply::make304(), maybeCacheable(), mcast_encode(), ClientHttpRequest::onlyIfCached(), Http::Message::putCc(), refreshCheck(), and HttpStateData::reusableReply().

◆ client_addr

◆ clientConnectionManager

CbcPointer<ConnStateData> HttpRequest::clientConnectionManager

The client connection manager, if known; Used for any response actions needed directly to the client. ie 1xx forwarding or connection pinning state changes

Definition at line 230 of file HttpRequest.h.

Referenced by Format::Format::assemble(), Ssl::PeekingPeerConnector::checkForPeekAndSplice(), Ssl::PeekingPeerConnector::checkForPeekAndSpliceGuess(), Ssl::PeekingPeerConnector::checkForPeekAndSpliceMatched(), clientCheckPinning(), FwdState::completed(), FwdState::connectStart(), copyResultsFromEntry(), FwdState::dispatch(), Ftp::Relay::forwardPreliminaryReply(), HttpStateData::handle1xx(), Ftp::Relay::handleControlReply(), Ssl::PeekingPeerConnector::handleServerCertificate(), inheritProperties(), Ssl::PeekingPeerConnector::initialize(), manager(), Ssl::PeekingPeerConnector::noteNegotiationDone(), pinnedConnection(), clientReplyContext::processExpired(), clientReplyContext::processMiss(), HttpStateData::processReplyBody(), PeerSelector::resolveSelected(), Ftp::Relay::sendCommand(), Ssl::PeekingPeerConnector::serverCertificateVerified(), Ftp::Relay::serverComplete(), ACLFilledChecklist::setRequest(), Ftp::Relay::startDirTracking(), Ftp::Relay::stopOriginWait(), FwdState::successfullyConnectedToPeer(), switchToTunnel(), and Ftp::Relay::updateMaster().

◆ content_length

int64_t Http::Message::content_length = 0

inherited

Definition at line 84 of file Message.h.

Referenced by Adaptation::Ecap::HeaderRep::add(), HttpReply::bodySize(), Http::Stream::buildRangeHeader(), HttpHdrRange::canonize(), CheckQuickAbortIsReasonable(), StoreEntry::checkTooBig(), clientBeginRequest(), clientIsContentLengthValid(), clientProcessRequest(), HttpReply::expectingBody(), expectingBody(), Downloader::handleReply(), HttpReply::hdrCacheInit(), Http::Message::hdrCacheInit(), StoreEntry::modifiedSince(), HttpStateData::persistentConnStatus(), HttpReply::redirect(), refreshIsCachable(), Adaptation::Ecap::HeaderRep::removeAny(), HttpStateData::sendRequest(), Http::Message::setContentLength(), HttpReply::setHeaders(), storeLog(), clientReplyContext::storeNotOKTransferDone(), HttpStateData::truncateVirginBody(), HttpReply::validatorsMatch(), and StoreEntry::validLength().

◆ dnsWait

int HttpRequest::dnsWait

Definition at line 159 of file HttpRequest.h.

Referenced by Format::Format::assemble(), inheritProperties(), init(), prepareLogWithRequestDetails(), and recordLookup().

◆ downloader

CbcPointer<Downloader> HttpRequest::downloader

Definition at line 233 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), Security::PeerConnector::checkForMissingCertificates(), inheritProperties(), and Security::PeerConnector::startCertDownloading().

◆ errDetail

int HttpRequest::errDetail

Definition at line 162 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clearError(), detailError(), inheritProperties(), init(), prepareLogWithRequestDetails(), and Ftp::Server::writeErrorReply().

◆ errType

err_type HttpRequest::errType

Definition at line 161 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clearError(), clone(), detailError(), inheritProperties(), init(), ACLSquidErrorStrategy::match(), prepareLogWithRequestDetails(), Ftp::Server::writeErrorReply(), and ClientHttpRequest::~ClientHttpRequest().

◆ etag

String HttpRequest::etag

Definition at line 192 of file HttpRequest.h.

Referenced by clean(), clone(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::processExpired(), clientReplyContext::restoreState(), and clientReplyContext::saveState().

◆ extacl_log

String HttpRequest::extacl_log

Definition at line 183 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), clone(), copyResultsFromEntry(), and init().

◆ extacl_message

String HttpRequest::extacl_message

Definition at line 185 of file HttpRequest.h.

Referenced by clean(), clone(), ErrorState::compileLegacyCode(), copyResultsFromEntry(), and init().

◆ extacl_passwd

String HttpRequest::extacl_passwd

Definition at line 181 of file HttpRequest.h.

Referenced by clean(), copyResultsFromEntry(), httpFixupAuthentication(), inheritProperties(), init(), and Adaptation::Icap::ModXact::makeRequestHeaders().

◆ extacl_user

String HttpRequest::extacl_user

Definition at line 179 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), copyResultsFromEntry(), AccessLogEntry::getExtUser(), httpFixupAuthentication(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Icap::ModXact::makeUsernameHeader(), ACLExtUser::match(), prepareLogWithRequestDetails(), statClientRequests(), and Adaptation::Ecap::XactionRep::usernameValue().

◆ flags

RequestFlags HttpRequest::flags

Definition at line 141 of file HttpRequest.h.

◆ forcedBodyContinuation

bool HttpRequest::forcedBodyContinuation

Definition at line 195 of file HttpRequest.h.

Referenced by HttpStateData::handle1xx(), Ftp::Server::handleUploadRequest(), inheritProperties(), init(), Http::One::Server::processParsedRequest(), and Ftp::Relay::readDataReply().

◆ hdr_sz

int Http::Message::hdr_sz = 0

inherited

◆ header

HttpHeader Http::Message::header

inherited

Definition at line 75 of file Message.h.

◆ hier

HierarchyLogEntry HttpRequest::hier

Definition at line 157 of file HttpRequest.h.

Referenced by Client::adjustBodyBytesRead(), clone(), ErrorState::compileLegacyCode(), StoreEntry::complete(), FwdState::completed(), FwdState::connectStart(), ErrorState::Dump(), gopherReadReply(), PeerSelector::handlePath(), Http::Tunneler::handleReadyRead(), Http::Tunneler::handleResponse(), Http::Tunneler::handleWrittenRequest(), ACLHierCodeStrategy::match(), neighborsDigestSelect(), peerNoteDigestLookup(), peerSelect(), prepareLogWithRequestDetails(), HttpStateData::processReplyHeader(), HttpStateData::readReply(), TunnelStateData::readServer(), FwdState::retryOrBail(), TunnelStateData::sendError(), clientReplyContext::sendMoreData(), Client::sentRequestBody(), ConnStateData::serveDelayedError(), Client::serverComplete(), TunnelStateData::startConnecting(), switchToTunnel(), FwdState::syncHierNote(), StoreEntry::timestampsSet(), tunnelConnectDone(), tunnelServerClosed(), TunnelStateData::writeServerDone(), and HttpStateData::wroteLast().

◆ http_ver

AnyP::ProtocolVersion Http::Message::http_ver

inherited

HTTP-Version field in the first line of the message. see RFC 7230 section 3.1

Definition at line 73 of file Message.h.

Referenced by Format::Format::assemble(), ErrorState::BuildHttpReply(), clientReplyContext::buildReplyHeader(), Downloader::buildRequest(), canHandle1xx(), clientBeginRequest(), clientProcessRequest(), ClientRequestContext::clientRedirectDone(), clientSetKeepaliveFlag(), clone(), HttpReply::clone(), ErrorState::compileLegacyCode(), ErrorState::Dump(), Adaptation::Icap::ModXact::encapsulateHead(), HttpReply::hdrCacheInit(), htcpClear(), htcpQuery(), HttpStateData::httpBuildRequestHeader(), netdbExchangeState::netdbExchangeState(), pack(), packFirstLineInto(), parseFirstLine(), Ftp::Server::parseOneRequest(), Http::Message::persistent(), prepareLogWithRequestDetails(), Adaptation::Ecap::FirstLineRep::protocol(), switchToTunnel(), tunnelStart(), and Adaptation::Ecap::FirstLineRep::version().

◆ icapHistory_

Adaptation::Icap::History::Pointer HttpRequest::icapHistory_

mutableprivate

Definition at line 122 of file HttpRequest.h.

Referenced by clean(), icapHistory(), inheritProperties(), and init().

◆ ims

time_t HttpRequest::ims

Definition at line 145 of file HttpRequest.h.

Referenced by clientInterpretRequestHeaders(), clone(), clientReplyContext::handleIMSReply(), init(), and clientReplyContext::processConditional().

◆ imslen

int HttpRequest::imslen

Definition at line 147 of file HttpRequest.h.

Referenced by clientInterpretRequestHeaders(), clone(), clientReplyContext::handleIMSReply(), init(), and clientReplyContext::processConditional().

◆ indirect_client_addr

Ip::Address HttpRequest::indirect_client_addr

Definition at line 152 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), clientBeginRequest(), clientFollowXForwardedForCheck(), Adaptation::Ecap::XactionRep::clientIpValue(), DelayId::DelayClient(), AccessLogEntry::getLogClientIp(), getOutgoingAddress(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeRequestHeaders(), manager(), and ACLFilledChecklist::setRequest().

◆ lastmod

time_t HttpRequest::lastmod

Definition at line 168 of file HttpRequest.h.

Referenced by clone(), HttpStateData::httpBuildRequestHeader(), init(), clientReplyContext::processExpired(), clientReplyContext::restoreState(), and clientReplyContext::saveState().

◆ masterXaction

MasterXaction::Pointer HttpRequest::masterXaction

Definition at line 236 of file HttpRequest.h.

Referenced by clone(), FindListeningPortAddress(), Acl::TransactionInitiator::match(), UrnState::setUriResFromRequest(), and Adaptation::Ecap::XactionRep::updateSources().

◆ method

HttpRequestMethod HttpRequest::method

Definition at line 114 of file HttpRequest.h.

◆ my_addr

Ip::Address HttpRequest::my_addr

Definition at line 155 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), clientBeginRequest(), DelayId::DelayClient(), ClientHttpRequest::doCallouts(), getRangeOffsetLimit(), inheritProperties(), init(), manager(), ACLFilledChecklist::setRequest(), and tunnelStart().

◆ myportname

String HttpRequest::myportname

Definition at line 175 of file HttpRequest.h.

Referenced by clean(), inheritProperties(), init(), manager(), ACLMyPortNameStrategy::match(), and ConnStateData::postHttpsAccept().

◆ peer_domain

char* HttpRequest::peer_domain

Definition at line 173 of file HttpRequest.h.

Referenced by copyOneHeaderFromClientsideRequestToUpstreamRequest(), HttpStateData::httpBuildRequestHeader(), init(), prepForDirect(), and prepForPeering().

◆ peer_host

char* HttpRequest::peer_host

Definition at line 166 of file HttpRequest.h.

Referenced by httpFixupAuthentication(), init(), HttpStateData::sendRequest(), switchToTunnel(), and tunnelConnectDone().

◆ peer_login

char* HttpRequest::peer_login

Definition at line 164 of file HttpRequest.h.

Referenced by clientReplyContext::buildReplyHeader(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), httpFixupAuthentication(), init(), prepForDirect(), and prepForPeering().

◆ pstate

ParseState Http::Message::pstate = Http::Message::psReadyToParseStartLine

inherited

Definition at line 95 of file Message.h.

Referenced by clone(), HttpReply::clone(), MemStore::copyFromShmSlice(), Http::Message::httpMsgParseStep(), init(), HttpReply::init(), and Http::Message::parseHeader().

◆ range

HttpHdrRange* HttpRequest::range

Definition at line 143 of file HttpRequest.h.

Referenced by Http::Stream::buildRangeHeader(), CheckQuickAbortIsReasonable(), clean(), clientInterpretRequestHeaders(), HttpStateData::decideIfWeDoRanges(), Http::Stream::getNextRangeOffset(), hdrCacheInit(), ignoreRange(), init(), Http::Stream::lengthToSend(), multipartRangeRequest(), Http::Stream::noteSentBodyBytes(), Http::Stream::prepareReply(), clientReplyContext::processReplyAccessResult(), Ftp::Gateway::restartable(), and Http::Stream::socketState().

◆ rangeOffsetLimit

int64_t HttpRequest::rangeOffsetLimit

mutableprivate

Definition at line 257 of file HttpRequest.h.

Referenced by getRangeOffsetLimit(), and init().

◆ sources

uint32_t Http::Message::sources = 0

inherited

Definition at line 100 of file Message.h.

Referenced by Ftp::Gateway::appendSuccessHeader(), ConnStateData::buildFakeRequest(), clientProcessRequest(), gopherReadReply(), Http::Tunneler::handleResponse(), HttpReply::inheritProperties(), inheritProperties(), Acl::ConnectionsEncrypted::match(), HttpStateData::processReplyHeader(), WhoisState::setReplyToOK(), Ftp::Relay::startDataDownload(), and Adaptation::Ecap::XactionRep::updateSources().

◆ store_id

String HttpRequest::store_id

If defined, store_id_program mapped the request URL to this ID. Store uses this ID (and not the URL) to find and store entries, avoiding caching duplicate entries when different URLs point to "essentially the same" cachable resource.

Definition at line 139 of file HttpRequest.h.

Referenced by storeId().

◆ tag

String HttpRequest::tag

Definition at line 177 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), clone(), copyResultsFromEntry(), DelayId::DelayClient(), init(), and ACLTagStrategy::match().

◆ theNotes

NotePairs::Pointer HttpRequest::theNotes

private

annotations added by the note directive and helpers and(or) by annotate_transaction/annotate_client ACLs.

Definition at line 261 of file HttpRequest.h.

Referenced by clean(), hasNotes(), inheritProperties(), and notes().

◆ url

AnyP::Uri HttpRequest::url

Definition at line 115 of file HttpRequest.h.

Referenced by Ftp::Gateway::appendSuccessHeader(), asnCacheStart(), Format::Format::assemble(), ConnStateData::buildFakeRequest(), Http::One::Server::buildHttpRequest(), Downloader::buildRequest(), HttpStateData::buildRequestPrefix(), Ftp::Gateway::buildTitleUrl(), clientReplyContext::cacheHit(), canonicalCleanUrl(), carpSelectParent(), Ftp::Gateway::checkAuth(), HttpStateData::checkDateSkew(), DestinationIPLookup::checkForAsync(), Ftp::Gateway::checkUrlpath(), clean(), clientHierarchical(), clientInterpretRequestHeaders(), clientProcessRequest(), ClientRequestContext::clientRedirectDone(), clone(), ErrorState::compileLegacyCode(), FwdState::connectStart(), HttpStateData::continueAfterParsingHeader(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), ICP2State::created(), FwdState::dispatch(), doV2Query(), ErrorState::Dump(), effectiveRequestUri(), Adaptation::Icap::ModXact::encapsulateHead(), FromUrl(), ftpFail(), ftpReadType(), Ftp::Gateway::ftpRealm(), ftpSendType(), ftpSendUser(), ftpTrySlashHack(), getDefaultParent(), getFirstUpParent(), TunnelStateData::getHost(), getRoundRobinParent(), getWeightedRoundRobinParent(), gopher_request_parse(), gopherSendComplete(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::identifyFoundObject(), init(), initHTTP(), Security::BlindPeerConnector::initialize(), Ssl::PeekingPeerConnector::initialize(), ConnStateData::initiateTunneledRequest(), internalStart(), ACLUrlPathStrategy::match(), ACLUrlPortStrategy::match(), ACLProtocolStrategy::match(), ACLUrlLoginStrategy::match(), ACLDestinationASNStrategy::match(), ACLDestinationDomainStrategy::match(), ACLServerNameStrategy::match(), ACLDestinationIP::match(), maybeCacheable(), neighborsHtcpReply(), neighborsUdpAck(), neighborsUdpPing(), netdbClosestParent(), netdbExchangeStart(), Ssl::PeekingPeerConnector::noteNegotiationDone(), operator<<(), pack(), packFirstLineInto(), parseFirstLine(), peerAllowedToUse(), peerDigestRequest(), ConnStateData::pinConnection(), ConnStateData::postHttpsAccept(), prefixLen(), HttpStateData::processReplyBody(), HttpStateData::processReplyHeader(), clientReplyContext::purgeRequest(), FwdState::secureConnectionToPeerIfNeeded(), HttpStateData::sendRequest(), ConnStateData::serveDelayedError(), Ssl::ServerBump::ServerBump(), UrnState::setUriResFromRequest(), PeerPoolMgr::start(), FwdState::Start(), Ftp::Gateway::start(), testHttpRequest::testCreateFromUrl(), testHttpRequest::testIPv6HostColonBug(), tunnelConnectDone(), Http::Tunneler::Tunneler(), Adaptation::Ecap::RequestLineRep::uri(), urlCanonicalFakeHttps(), urlCheckRequest(), urlMakeAbsolute(), Ftp::UrlWith2f(), FwdState::usePinned(), ConnStateData::validatePinnedConnection(), Adaptation::Service::wants(), and whoisStart().

◆ vary_headers

SBuf HttpRequest::vary_headers

Definition at line 171 of file HttpRequest.h.

Referenced by StoreEntry::adjustVary(), clean(), clone(), init(), clientReplyContext::processExpired(), clientReplyContext::purgeDoPurgeHead(), storeKeyPublicByRequestMethod(), and varyEvaluateMatch().

◆ x_forwarded_for_iterator

String HttpRequest::x_forwarded_for_iterator

Definition at line 188 of file HttpRequest.h.

Referenced by clientFollowXForwardedForCheck().

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

squid-cache.org

Optimising Web Delivery

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Member Enumeration Documentation

◆ ParseState

◆ Sources

Constructor & Destructor Documentation

◆ HttpRequest() [1/2]

◆ HttpRequest() [2/2]

◆ ~HttpRequest()

Member Function Documentation

◆ adaptHistory()

◆ adaptHistoryImport()

◆ adaptLogHistory()

◆ bodyNibbled()

◆ canHandle1xx()

◆ canonicalCleanUrl()

◆ clean()

◆ clearError()

◆ clone()

◆ conditional()

◆ configureContentLengthInterpreter()

◆ detailError()

◆ effectiveRequestUri()

◆ expectingBody()

◆ firstLineBuf()

◆ FromUrl()

◆ getRangeOffsetLimit()

◆ hasNotes()

◆ hdrCacheInit()

◆ httpMsgParseError()

◆ httpMsgParseStep()

◆ httpRequestPack()

◆ icapHistory()

◆ ignoreRange()

◆ inheritProperties()

◆ init()

◆ initHTTP()

◆ manager()

◆ maybeCacheable()

◆ multipartRangeRequest()

◆ notes()

◆ operator delete()

◆ operator new()

◆ pack()

◆ packFirstLineInto()

◆ packInto()

◆ parse()

◆ parseCharBuf()

◆ parseFirstLine()

◆ parseHeader() [1/3]

◆ parseHeader() [2/3]

◆ parseHeader() [3/3]

◆ persistent()

◆ pinnedConnection()

◆ Pool()

◆ prefixLen()

◆ prepForDirect()

◆ prepForPeering()

◆ putCc()

◆ recordLookup()

◆ reset()

◆ sanityCheckStartLine()

◆ setContentLength()

◆ storeId()

◆ swapOut()

◆ UseCount()

Member Data Documentation

◆ adaptHistory_

◆ auth_user_request

◆ body_pipe