provides Coordinator with a local cache manager response More...

#include <Filler.h>

Inheritance diagram for Mgr::Filler:

Collaboration diagram for Mgr::Filler:

Public Types
typedef CbcPointer< AsyncJob >	Pointer

Public Member Functions
	Filler (const Action::Pointer &, const Comm::ConnectionPointer &, Ipc::RequestId)

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

void	callStart (AsyncCall &call)

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

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

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

virtual void *	toCbdata ()=0

Static Public Member Functions
static void	Start (const Pointer &job)

static void	RegisterWithCacheManager ()

Public Attributes
const InstanceId< AsyncJob >	id
	job identifier

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

void	swanSong () override

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

void	scheduleStoreCopy ()
	request more action results from the store

void	noteStoreCopied (StoreIOBuffer ioBuf)
	receive some action results from the store

void	scheduleCommWrite (const StoreIOBuffer &ioBuf)
	tell Comm to write action results

void	noteCommWrote (const CommIoCbParams &params)
	called by Comm after the action results are written

void	noteCommClosed (const CommCloseCbParams &params)
	called by Comm if the client socket got closed

void	close ()
	closes the local connection to the HTTP client, if any

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	NoteStoreCopied (void *data, StoreIOBuffer ioBuf)

static void	HandleStoreAbort (StoreToCommWriter *param)
	called by Store if the entry is no longer usable

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

Protected Attributes
Comm::ConnectionPointer	clientConnection
	HTTP client descriptor.

StoreEntry *	entry
	store entry with the cache manager response

store_client *	sc
	our registration with the store

int64_t	writeOffset
	number of bytes written to the client

AsyncCall::Pointer	closer
	comm_close handler

char	buffer [HTTP_REQBUF_SZ]
	action results; Store fills, Comm writes

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

Private Member Functions
	CBDATA_CHILD (Filler)

	CBDATA_INTERMEDIATE ()

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

Private Attributes
Action::Pointer	action
	action that will run() and sendResponse()

Ipc::RequestId	requestId
	the ID of the Request we are responding to

Detailed Description

Definition at line 23 of file Filler.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Filler()

Mgr::Filler::Filler	(	const Action::Pointer &	anAction,
		const Comm::ConnectionPointer &	conn,
		Ipc::RequestId	aRequestId
	)

Definition at line 21 of file Filler.cc.

References action, and debugs.

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 AsyncJob::callException ( const std::exception & e )

virtualinherited

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

Definition at line 143 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 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::Filler::CBDATA_CHILD ( Filler )

private

◆ CBDATA_INTERMEDIATE()

Mgr::StoreToCommWriter::CBDATA_INTERMEDIATE ( )

privateinherited

◆ close()

void Mgr::StoreToCommWriter::close ( )

protectedinherited

closes our copy of the client HTTP connection socket

Definition at line 43 of file StoreToCommWriter.cc.

References comm_remove_close_handler(), and Comm::IsConnOpen().

◆ 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().

◆ 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 Mgr::StoreToCommWriter::doneAll ( ) const

overrideprotectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 158 of file StoreToCommWriter.cc.

References STORE_OK.

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ HandleStoreAbort()

void Mgr::StoreToCommWriter::HandleStoreAbort ( StoreToCommWriter * param )

staticprotectedinherited

Definition at line 166 of file StoreToCommWriter.cc.

References Mgr::StoreToCommWriter::clientConnection, Comm::Connection::close(), and Comm::IsConnOpen().

Referenced by Mgr::StoreToCommWriter::start().

◆ 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::StoreToCommWriter::noteCommClosed ( const CommCloseCbParams & params )

protectedinherited

Definition at line 130 of file StoreToCommWriter.cc.

References debugs, and MYNAME.

Referenced by Mgr::StoreToCommWriter::StoreToCommWriter().

◆ noteCommWrote()

void Mgr::StoreToCommWriter::noteCommWrote ( const CommIoCbParams & params )

protectedinherited

Definition at line 118 of file StoreToCommWriter.cc.

References debugs, CommCommonCbParams::fd, CommCommonCbParams::flag, Must, MYNAME, Comm::OK, and CommIoCbParams::size.

Referenced by Mgr::StoreToCommWriter::scheduleCommWrite().

◆ noteStoreCopied()

void Mgr::StoreToCommWriter::noteStoreCopied ( StoreIOBuffer ioBuf )

protectedinherited

Definition at line 93 of file StoreToCommWriter.cc.

References debugs, StoreIOBuffer::error, StoreIOBuffer::flags, StoreIOBuffer::length, Must, and MYNAME.

Referenced by Mgr::StoreToCommWriter::NoteStoreCopied().

◆ NoteStoreCopied()

void Mgr::StoreToCommWriter::NoteStoreCopied	(	void *	data,
		StoreIOBuffer	ioBuf
	)

staticprotectedinherited

Definition at line 80 of file StoreToCommWriter.cc.

References asyncCall(), Must, Mgr::StoreToCommWriter::noteStoreCopied(), and ScheduleCallHere.

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

staticinherited

Definition at line 215 of file AsyncJob.cc.

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

Referenced by mainInitialize().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry * e )

staticprotectedinherited

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ scheduleCommWrite()

void Mgr::StoreToCommWriter::scheduleCommWrite ( const StoreIOBuffer & ioBuf )

protectedinherited

Definition at line 104 of file StoreToCommWriter.cc.

References asyncCall(), StoreIOBuffer::data, debugs, Comm::IsConnOpen(), StoreIOBuffer::length, Must, MYNAME, Mgr::StoreToCommWriter::noteCommWrote(), and Comm::Write().

◆ scheduleStoreCopy()

void Mgr::StoreToCommWriter::scheduleStoreCopy ( )

protectedinherited

Definition at line 70 of file StoreToCommWriter.cc.

References debugs, Must, MYNAME, and storeClientCopy().

◆ start()

void Mgr::Filler::start ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 31 of file Filler.cc.

References debugs, Must, MYNAME, and Mgr::StoreToCommWriter::start().

◆ 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::Filler::swanSong ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 42 of file Filler.cc.

References debugs, MYNAME, and Mgr::StoreToCommWriter::swanSong().

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

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

Member Data Documentation

◆ action

Action::Pointer Mgr::Filler::action

private

Definition at line 36 of file Filler.h.

Referenced by Filler().

◆ buffer

char Mgr::StoreToCommWriter::buffer[HTTP_REQBUF_SZ]

protectedinherited

Definition at line 69 of file StoreToCommWriter.h.

◆ clientConnection

Comm::ConnectionPointer Mgr::StoreToCommWriter::clientConnection

protectedinherited

Definition at line 62 of file StoreToCommWriter.h.

Referenced by Mgr::StoreToCommWriter::StoreToCommWriter(), and Mgr::StoreToCommWriter::HandleStoreAbort().

◆ closer

AsyncCall::Pointer Mgr::StoreToCommWriter::closer

protectedinherited

Definition at line 68 of file StoreToCommWriter.h.

Referenced by Mgr::StoreToCommWriter::StoreToCommWriter().

◆ entry

StoreEntry* Mgr::StoreToCommWriter::entry

protectedinherited

Definition at line 64 of file StoreToCommWriter.h.

◆ 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().

◆ requestId

Ipc::RequestId Mgr::Filler::requestId

private

Definition at line 37 of file Filler.h.

◆ sc

store_client* Mgr::StoreToCommWriter::sc

protectedinherited

Definition at line 65 of file StoreToCommWriter.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().

◆ 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().

◆ writeOffset

int64_t Mgr::StoreToCommWriter::writeOffset

protectedinherited

Definition at line 66 of file StoreToCommWriter.h.

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

squid/src/mgr/Filler.h
squid/src/mgr/Filler.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ Filler()

Member Function Documentation

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ CBDATA_CHILD()

◆ CBDATA_INTERMEDIATE()

◆ close()

◆ deleteThis()

◆ done()

◆ doneAll()

◆ finalizedInCbdataChild()

◆ handleStopRequest()

◆ HandleStoreAbort()

◆ mustStop()

◆ noteCommClosed()

◆ noteCommWrote()

◆ noteStoreCopied()

◆ NoteStoreCopied()

◆ RegisterWithCacheManager()

◆ ReportAllJobs()

◆ scheduleCommWrite()

◆ scheduleStoreCopy()

◆ start()

◆ Start()

◆ status()

◆ swanSong()

◆ toCbdata()

Member Data Documentation

◆ action

◆ buffer

◆ clientConnection

◆ closer

◆ entry

◆ id

◆ inCall

◆ requestId

◆ sc

◆ started_

◆ stopReason

◆ swanSang_

◆ typeName

◆ writeOffset