#include <AsyncJob.h>

Inheritance diagram for AsyncJob:

Collaboration diagram for AsyncJob:

Public Types
typedef CbcPointer< AsyncJob >	Pointer

Public Member Functions
	AsyncJob (const char *aTypeName)

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

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

Protected Member Functions
void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

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

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

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

virtual void	swanSong ()

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

	~AsyncJob () override

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

Protected Attributes
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 Member Functions
virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

Detailed Description

Base class for all asynchronous jobs

Definition at line 31 of file AsyncJob.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ AsyncJob()

AsyncJob::AsyncJob ( const char * aTypeName )

Definition at line 43 of file AsyncJob.cc.

References AllJobs(), debugs, and typeName.

◆ ~AsyncJob()

AsyncJob::~AsyncJob ( )

overrideprotected

Definition at line 51 of file AsyncJob.cc.

References AllJobs(), assert, debugs, started_, swanSang_, and typeName.

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )

virtual

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, done(), inCall, started_, status(), swanSang_, swanSong(), and typeName.

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

◆ callException()

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

virtual

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

Definition at line 143 of file AsyncJob.cc.

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

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

called just before the called method

Definition at line 130 of file AsyncJob.cc.

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

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall & call ) const

Definition at line 117 of file AsyncJob.cc.

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

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protected

Definition at line 65 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed().

◆ done()

bool AsyncJob::done ( ) const

protected

Definition at line 106 of file AsyncJob.cc.

References doneAll(), and stopReason.

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

◆ doneAll()

bool AsyncJob::doneAll ( ) const

protectedvirtual

Reimplemented in Adaptation::Icap::ModXact, ConnStateData, ClientHttpRequest, HappyConnOpener, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Adaptation::Ecap::XactionRep, Ipc::UdsSender, Client, Rock::Rebuild, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Security::PeerConnector, Downloader, Log::TcpLogger, Http::Tunneler, Adaptation::Iterator, Ipc::Forwarder, Comm::TcpAcceptor, Ipc::Inquirer, Rock::HeaderUpdater, PeerPoolMgr, Mgr::StoreToCommWriter, Server, Mgr::Inquirer, Snmp::Inquirer, BodySink, Ipc::Port, and Comm::ConnOpener.

Definition at line 112 of file AsyncJob.cc.

Referenced by done(), Comm::ConnOpener::doneAll(), BodySink::doneAll(), Server::doneAll(), PeerPoolMgr::doneAll(), Rock::HeaderUpdater::doneAll(), Comm::TcpAcceptor::doneAll(), Adaptation::Iterator::doneAll(), Log::TcpLogger::doneAll(), Downloader::doneAll(), Security::PeerConnector::doneAll(), Adaptation::Icap::Launcher::doneAll(), Rock::Rebuild::doneAll(), Client::doneAll(), Ipc::UdsSender::doneAll(), Adaptation::Ecap::XactionRep::doneAll(), Adaptation::Icap::Xaction::doneAll(), Adaptation::Icap::ServiceRep::doneAll(), ClientHttpRequest::doneAll(), and ConnStateData::doneAll().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inline

Definition at line 73 of file AsyncJob.h.

References mustStop().

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protected

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

static

Definition at line 215 of file AsyncJob.cc.

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

Referenced by mainInitialize().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry * e )

staticprotected

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by RegisterWithCacheManager().

◆ start()

void AsyncJob::start ( )

protectedvirtual

Reimplemented in Ipc::Port, ConnStateData, Adaptation::Icap::ModXact, Ftp::Client, HappyConnOpener, Ftp::Gateway, Ftp::Server, HttpStateData, Adaptation::Ecap::XactionRep, Ipc::UdsSender, Adaptation::Icap::Xaction, Rock::Rebuild, Downloader, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Security::PeerConnector, Ftp::Relay, Log::TcpLogger, Http::Tunneler, Adaptation::Iterator, Http::One::Server, Ipc::Forwarder, Comm::TcpAcceptor, Ipc::Coordinator, Ipc::Inquirer, Rock::HeaderUpdater, Comm::ConnOpener, PeerPoolMgr, Mgr::StoreToCommWriter, Server, Mgr::Inquirer, Snmp::Inquirer, Adaptation::Icap::OptXact, Ipc::Strand, Mgr::Filler, and Mgr::ActionWriter.

Definition at line 59 of file AsyncJob.cc.

Referenced by Ipc::Port::start(), PeerPoolMgr::start(), Start(), Adaptation::Iterator::start(), Http::Tunneler::start(), Adaptation::AccessCheck::start(), Adaptation::Icap::Launcher::start(), Security::PeerConnector::start(), Adaptation::Icap::Xaction::start(), Ipc::UdsSender::start(), and ConnStateData::start().

◆ Start()

void AsyncJob::Start ( const Pointer & job )

static

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, start(), and 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(), Adaptation::AccessCheck::Start(), CacheManager::start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), and Rock::SwapDir::updateHeaders().