#include <Forwarder.h>

Inheritance diagram for Mgr::Forwarder:

Collaboration diagram for Mgr::Forwarder:

Public Types
typedef CbcPointer< AsyncJob >	Pointer

Public Member Functions
	Forwarder (const Comm::ConnectionPointer &aConn, const ActionParams &aParams, HttpRequest aRequest, StoreEntry anEntry, const AccessLogEntryPointer &anAle)

	~Forwarder () override

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

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

void	callStart (AsyncCall &call)

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

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

virtual void *	toCbdata ()=0

Static Public Member Functions
static void	HandleRemoteAck (RequestId)
	finds and calls the right Forwarder upon Coordinator's response

static void	Start (const Pointer &job)

static void	RegisterWithCacheManager ()

Public Attributes
CodeContextPointer	codeContext

const InstanceId< AsyncJob >	id
	job identifier

Protected Types
typedef std::map< RequestId::Index, AsyncCall::Pointer >	RequestsMap
	maps request->id to Forwarder::handleRemoteAck callback

Protected Member Functions
void	swanSong () override
	closes our copy of the client HTTP connection socket

void	handleError () override

void	handleTimeout () override

void	handleException (const std::exception &e) override
	terminate with an error

void	start () override
	called by AsyncStart; do not call directly

bool	doneAll () const override
	whether positive goal has been reached

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

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

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

Static Protected Member Functions
static void	ReportAllJobs (StoreEntry *)
	writes a cache manager report about all jobs existing in this worker

Protected Attributes
Request::Pointer	request

const double	timeout
	response wait timeout in seconds

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

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

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

bool	started_ = false
	Start() has finished successfully.

bool	swanSang_ = false
	swanSong() was called

Static Protected Attributes
static RequestsMap	TheRequestsMap
	pending Coordinator requests

static RequestId::Index	LastRequestId = 0
	last requestId used

Private Member Functions
	CBDATA_CHILD (Forwarder)

void	noteCommClosed (const CommCloseCbParams &params)
	called when the client socket gets closed by some external force

void	sendError (ErrorState *error)
	send error page

	CBDATA_INTERMEDIATE ()

void	requestTimedOut ()
	called when Coordinator fails to start processing the request [in time]

void	removeTimeoutEvent ()
	called when we are no longer waiting for Coordinator to respond

void	handleRemoteAck ()
	called when Coordinator starts processing the request

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE()

Static Private Member Functions
static void	RequestTimedOut (void *param)
	Ipc::Forwarder::requestTimedOut wrapper.

static AsyncCall::Pointer	DequeueRequest (RequestId::Index)
	returns and forgets the right Forwarder callback for the request

Private Attributes
HttpRequest *	httpRequest
	HTTP client request for detailing errors.

StoreEntry *	entry
	Store entry expecting the response.

Comm::ConnectionPointer	conn
	HTTP client connection descriptor.

AsyncCall::Pointer	closer
	comm_close handler for the HTTP connection

AccessLogEntryPointer	ale
	more transaction details

Detailed Description

Forwards a single client cache manager request to Coordinator. Waits for an ACK from Coordinator while holding the Store entry. Fills the store entry with an error response if forwarding fails.

Definition at line 31 of file Forwarder.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

◆ RequestsMap

typedef std::map<RequestId::Index, AsyncCall::Pointer> Ipc::Forwarder::RequestsMap

protectedinherited

Definition at line 69 of file Forwarder.h.

Constructor & Destructor Documentation

◆ Forwarder()

Mgr::Forwarder::Forwarder	(	const Comm::ConnectionPointer &	aConn,
		const ActionParams &	aParams,
		HttpRequest *	aRequest,
		StoreEntry *	anEntry,
		const AccessLogEntryPointer &	anAle
	)

Definition at line 29 of file Forwarder.cc.

References asyncCall(), closer, comm_add_close_handler(), conn, debugs, entry, Comm::Connection::fd, HTTPMSGLOCK(), httpRequest, Comm::IsConnOpen(), StoreEntry::lock(), Must, and noteCommClosed().

◆ ~Forwarder()

Mgr::Forwarder::~Forwarder ( )

override

Definition at line 50 of file Forwarder.cc.

References HTTPMSGUNLOCK(), Must, and SWALLOW_EXCEPTIONS.

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 152 of file AsyncJob.cc.

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

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

◆ callException()

void Ipc::Forwarder::callException ( const std::exception & e )

overridevirtualinherited

Reimplemented from AsyncJob.

Definition at line 139 of file Forwarder.cc.

References AsyncJob::callException(), DBG_CRITICAL, and debugs.

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 130 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 117 of file AsyncJob.cc.

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

◆ CBDATA_CHILD()

Mgr::Forwarder::CBDATA_CHILD ( Forwarder )

private

◆ CBDATA_INTERMEDIATE()

Ipc::Forwarder::CBDATA_INTERMEDIATE ( )

privateinherited

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 65 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed(), and AsyncJob::deleteThis().

◆ DequeueRequest()

AsyncCall::Pointer Ipc::Forwarder::DequeueRequest ( RequestId::Index requestId )

staticprivateinherited

Definition at line 151 of file Forwarder.cc.

References debugs, Must, and MYNAME.

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 106 of file AsyncJob.cc.

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

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

◆ doneAll()

bool Ipc::Forwarder::doneAll ( ) const

overrideprotectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 78 of file Forwarder.cc.

References debugs, and MYNAME.

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleError()

void Mgr::Forwarder::handleError ( )

overrideprotectedvirtual

Reimplemented from Ipc::Forwarder.

Definition at line 76 of file Forwarder.cc.

References DBG_CRITICAL, debugs, ERR_INVALID_URL, and Http::scUriTooLong.

◆ handleException()

void Mgr::Forwarder::handleException ( const std::exception & e )

overrideprotectedvirtual

Reimplemented from Ipc::Forwarder.

Definition at line 91 of file Forwarder.cc.

References ERR_INVALID_RESP, Ipc::Forwarder::handleException(), Comm::IsConnOpen(), and Http::scInternalServerError.

◆ handleRemoteAck()

void Ipc::Forwarder::handleRemoteAck ( )

privateinherited

Definition at line 86 of file Forwarder.cc.

References debugs, and MYNAME.

Referenced by Ipc::Forwarder::start().

◆ HandleRemoteAck()

void Ipc::Forwarder::HandleRemoteAck ( RequestId requestId )

staticinherited

Definition at line 174 of file Forwarder.cc.

References debugs, Ipc::DequeueRequest(), Must, MYNAME, and ScheduleCallHere.

Referenced by Ipc::Strand::handleCacheMgrResponse(), and Ipc::Strand::handleSnmpResponse().

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ handleTimeout()

void Mgr::Forwarder::handleTimeout ( )

overrideprotectedvirtual

Reimplemented from Ipc::Forwarder.

Definition at line 84 of file Forwarder.cc.

References ERR_LIFETIME_EXP, Ipc::Forwarder::handleTimeout(), and Http::scRequestTimeout.

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

Definition at line 85 of file AsyncJob.cc.

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

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

◆ noteCommClosed()

void Mgr::Forwarder::noteCommClosed ( const CommCloseCbParams & params )

private

Definition at line 100 of file Forwarder.cc.

References debugs, and MYNAME.

Referenced by Forwarder().

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

staticinherited

Definition at line 215 of file AsyncJob.cc.

References Mgr::RegisterAction(), and AsyncJob::ReportAllJobs().

Referenced by mainInitialize().

◆ removeTimeoutEvent()

void Ipc::Forwarder::removeTimeoutEvent ( )

privateinherited

Definition at line 167 of file Forwarder.cc.

References eventDelete(), eventFind(), and Ipc::Forwarder::RequestTimedOut().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry * e )

staticprotectedinherited

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ requestTimedOut()

void Ipc::Forwarder::requestTimedOut ( )

privateinherited

Definition at line 112 of file Forwarder.cc.

References debugs, and MYNAME.

◆ RequestTimedOut()

void Ipc::Forwarder::RequestTimedOut ( void * param )

staticprivateinherited

Definition at line 98 of file Forwarder.cc.

References CallBack(), Ipc::Forwarder::codeContext, debugs, Must, and MYNAME.

Referenced by Ipc::Forwarder::removeTimeoutEvent(), and Ipc::Forwarder::start().

◆ sendError()

void Mgr::Forwarder::sendError ( ErrorState * error )

private

Definition at line 113 of file Forwarder.cc.

References debugs, error(), Must, MYNAME, and squid_curtime.

◆ start()

void Ipc::Forwarder::start ( )

overrideprotectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 40 of file Forwarder.cc.

References Ipc::Port::CoordinatorAddr(), debugs, eventAdd(), Ipc::Forwarder::handleRemoteAck(), JobCallback, MYNAME, Ipc::Forwarder::RequestTimedOut(), and Ipc::SendMessage().

◆ 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 37 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(), and Rock::SwapDir::updateHeaders().

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

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

Definition at line 182 of file AsyncJob.cc.

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

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

◆ swanSong()

void Mgr::Forwarder::swanSong ( )

overrideprotectedvirtual

Reimplemented from Ipc::Forwarder.

Definition at line 62 of file Forwarder.cc.

References comm_remove_close_handler(), Comm::IsConnOpen(), and Ipc::Forwarder::swanSong().

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

Member Data Documentation

◆ ale

AccessLogEntryPointer Mgr::Forwarder::ale

private

Definition at line 56 of file Forwarder.h.

◆ closer

AsyncCall::Pointer Mgr::Forwarder::closer

private

Definition at line 55 of file Forwarder.h.

Referenced by Forwarder().

◆ codeContext

CodeContextPointer Ipc::Forwarder::codeContext

inherited

Definition at line 43 of file Forwarder.h.

Referenced by Ipc::Forwarder::RequestTimedOut().

◆ conn

Comm::ConnectionPointer Mgr::Forwarder::conn

private

Definition at line 54 of file Forwarder.h.

Referenced by Forwarder().

◆ entry

StoreEntry* Mgr::Forwarder::entry

private

Definition at line 53 of file Forwarder.h.

Referenced by Forwarder().

◆ httpRequest

HttpRequest* Mgr::Forwarder::httpRequest

private

Definition at line 52 of file Forwarder.h.

Referenced by Forwarder().

◆ id

const InstanceId<AsyncJob> AsyncJob::id

inherited

Definition at line 75 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 86 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ LastRequestId

Ipc::RequestId::Index Ipc::Forwarder::LastRequestId = 0

staticprotectedinherited

Definition at line 72 of file Forwarder.h.

◆ request

Request::Pointer Ipc::Forwarder::request

protectedinherited

Definition at line 65 of file Forwarder.h.

◆ started_

bool AsyncJob::started_ = false

protectedinherited

Definition at line 88 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason

protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ swanSang_

bool AsyncJob::swanSang_ = false

protectedinherited

Definition at line 89 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ TheRequestsMap

Ipc::Forwarder::RequestsMap Ipc::Forwarder::TheRequestsMap

staticprotectedinherited

Definition at line 70 of file Forwarder.h.

◆ timeout

const double Ipc::Forwarder::timeout

protectedinherited

Definition at line 66 of file Forwarder.h.

◆ typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 85 of file AsyncJob.h.

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

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

squid/src/mgr/Forwarder.h
squid/src/mgr/Forwarder.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

◆ RequestsMap

Constructor & Destructor Documentation

◆ Forwarder()

◆ ~Forwarder()

Member Function Documentation

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ CBDATA_CHILD()

◆ CBDATA_INTERMEDIATE()

◆ deleteThis()

◆ DequeueRequest()

◆ done()

◆ doneAll()

◆ finalizedInCbdataChild()

◆ handleError()

◆ handleException()

◆ handleRemoteAck()

◆ HandleRemoteAck()

◆ handleStopRequest()

◆ handleTimeout()

◆ mustStop()

◆ noteCommClosed()

◆ RegisterWithCacheManager()

◆ removeTimeoutEvent()

◆ ReportAllJobs()

◆ requestTimedOut()

◆ RequestTimedOut()

◆ sendError()

◆ start()

◆ Start()

◆ status()

◆ swanSong()

◆ toCbdata()

Member Data Documentation

◆ ale

◆ closer

◆ codeContext

◆ conn

◆ entry

◆ httpRequest

◆ id

◆ inCall

◆ LastRequestId

◆ request

◆ started_

◆ stopReason

◆ swanSang_

◆ TheRequestsMap

◆ timeout

◆ typeName