AsyncJob Class Reference

#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...
virtual void *	toCbdata ()=0

Static Public Member Functions
static Pointer	Start (AsyncJob *job)
	starts a freshly created job (i.e., makes the job asynchronous) 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...
virtual	~AsyncJob ()

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...
const InstanceId< AsyncJob >	id
	job identifier 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 30 of file AsyncJob.cc.

References debugs, and typeName.

~AsyncJob()

AsyncJob::~AsyncJob ( )

protectedvirtual

Definition at line 37 of file AsyncJob.cc.

References debugs, and typeName.

Referenced by swanSong().

Member Function Documentation

callEnd()

void AsyncJob::callEnd ( )

virtual

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 136 of file AsyncJob.cc.

References AsyncCall::debugLevel, debugs, AsyncCall::debugSection, done(), HERE(), inCall, NULL, status(), swanSong(), and typeName.

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

callException()

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

virtual

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

Definition at line 127 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 swanSong().

callStart()

void AsyncJob::callStart

(

AsyncCall &

call

)

called just before the called method

Definition at line 114 of file AsyncJob.cc.

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

Referenced by swanSong().

canBeCalled()

bool AsyncJob::canBeCalled

(

AsyncCall &

call

)

const

Definition at line 101 of file AsyncJob.cc.

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

Referenced by swanSong().

deleteThis()

void AsyncJob::deleteThis ( const char *  aReason )

protected

Definition at line 49 of file AsyncJob.cc.

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

done()

bool AsyncJob::done ( ) const

protected

Definition at line 90 of file AsyncJob.cc.

References doneAll(), NULL, and stopReason.

Referenced by Adaptation::Ecap::XactionRep::blockVirgin(), callEnd(), Adaptation::AccessCheck::checkCandidates(), HappyConnOpener::checkForNewConnection(), Rock::Rebuild::checkpoint(), Downloader::downloadFinished(), Comm::TcpAcceptor::handleClosure(), Adaptation::Icap::OptXact::handleCommRead(), Ipc::Inquirer::handleRemoteAck(), Ipc::Inquirer::inquire(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), Adaptation::AccessCheck::noteAnswer(), Adaptation::Icap::Launcher::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteXactAbort(), Ipc::Inquirer::requestTimedOut(), Adaptation::Iterator::step(), Adaptation::AccessCheck::usedDynamicRules(), and Adaptation::Ecap::XactionRep::useVirgin().

doneAll()

bool AsyncJob::doneAll ( ) const

protectedvirtual

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

Definition at line 96 of file AsyncJob.cc.

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

mustStop()

void AsyncJob::mustStop ( const char *  aReason )

protected

Definition at line 69 of file AsyncJob.cc.

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

Referenced by HttpStateData::abortAll(), Ftp::Client::abortAll(), Comm::TcpAcceptor::acceptOne(), Adaptation::Ecap::XactionRep::adaptationAborted(), Adaptation::AccessCheck::callBack(), callException(), Security::PeerConnector::connectionClosed(), HttpStateData::continueAfterParsingHeader(), Ftp::Client::ctrlClosed(), Adaptation::Iterator::handleAdaptationBlock(), Adaptation::Iterator::handleAdaptationError(), Log::TcpLogger::handleClosure(), Adaptation::Icap::Xaction::handleCommClosed(), Http::Tunneler::handleConnectionClosure(), Mgr::Forwarder::handleError(), Ipc::Forwarder::handleError(), Ipc::Forwarder::handleException(), Ipc::Inquirer::handleException(), HttpStateData::handleMoreRequestBodyAvailable(), Ipc::Inquirer::handleRemoteAck(), Ipc::Forwarder::handleTimeout(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), Adaptation::Icap::ModXact::noteBodyConsumerAborted(), Snmp::Forwarder::noteCommClosed(), Snmp::Inquirer::noteCommClosed(), Mgr::Inquirer::noteCommClosed(), Mgr::Forwarder::noteCommClosed(), Mgr::StoreToCommWriter::noteCommClosed(), Adaptation::Icap::Xaction::noteCommRead(), Rock::HeaderUpdater::noteDoneReading(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Ecap::XactionRep::noteInitiatorAborted(), HttpStateData::readReply(), Comm::ConnOpener::sendAnswer(), Rock::Rebuild::start(), Security::PeerConnector::start(), HttpStateData::start(), Ipc::UdsSender::timedout(), and HttpStateData::wroteLast().

Start()

AsyncJob::Pointer AsyncJob::Start ( AsyncJob *  job )

static

Definition at line 23 of file AsyncJob.cc.

References CallJobHere, and start().

Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), TunnelStateData::connectedToPeer(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), FwdState::establishTunnelThruProxy(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Adaptation::Initiator::initiateAdaptation(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), HappyConnOpener::openFreshConnection(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeerIfNeeded(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

start()

void AsyncJob::start ( )

protectedvirtual

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

Definition at line 43 of file AsyncJob.cc.

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

status()

const char * AsyncJob::status ( ) const

protectedvirtual

for debugging, starts with space

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

Definition at line 159 of file AsyncJob.cc.

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

Referenced by BodyPipe::buf(), callEnd(), callStart(), ClientRequestContext::clientAccessCheckDone(), ClientRequestContext::clientRedirectDone(), Ftp::Client::ctrlClosed(), Ftp::Relay::dataChannelConnected(), Ftp::Client::dataClosed(), Ftp::Client::dataComplete(), Ftp::Client::doneSendingRequestBody(), Ftp::Client::handleControlReply(), Ftp::Client::handleEpsvReply(), Ftp::Client::handlePasvReply(), Ftp::Client::parseControlReply(), Ftp::Relay::processReplyBody(), Ftp::Gateway::processReplyBody(), Ftp::Relay::readTransferDoneReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), Adaptation::Initiate::status(), Comm::TcpAcceptor::status(), and swanSong().

swanSong()

virtual void AsyncJob::swanSong ( )

inlineprotectedvirtual

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

Definition at line 54 of file AsyncJob.h.

References callEnd(), callException(), callStart(), canBeCalled(), status(), and ~AsyncJob().

Referenced by callEnd(), PeerPoolMgr::swanSong(), Server::swanSong(), Comm::ConnOpener::swanSong(), Rock::HeaderUpdater::swanSong(), Comm::TcpAcceptor::swanSong(), Log::TcpLogger::swanSong(), Ipc::UdsSender::swanSong(), Client::swanSong(), Http::Tunneler::swanSong(), Security::PeerConnector::swanSong(), and HappyConnOpener::swanSong().

toCbdata()

virtual void* CbdataParent::toCbdata ( )

pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

Referenced by callException(), callStart(), and CbdataParent::~CbdataParent().

Member Data Documentation

id

const InstanceId<AsyncJob> AsyncJob::id

protected

Definition at line 72 of file AsyncJob.h.

inCall

AsyncCall::Pointer AsyncJob::inCall

protected

Definition at line 71 of file AsyncJob.h.

Referenced by callEnd(), Adaptation::Icap::ModXact::callException(), callStart(), canBeCalled(), deleteThis(), Log::TcpLogger::endGracefully(), Log::TcpLogger::handleClosure(), and mustStop().

stopReason

const char* AsyncJob::stopReason

protected

Definition at line 69 of file AsyncJob.h.

Referenced by deleteThis(), done(), mustStop(), status(), Http::Tunneler::status(), Security::PeerConnector::status(), and HappyConnOpener::status().

typeName

const char* AsyncJob::typeName

protected

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob(), callEnd(), Adaptation::Icap::Xaction::callEnd(), callStart(), deleteThis(), Adaptation::Icap::Xaction::dieOnConnectionFailure(), Adaptation::Icap::Xaction::disableRepeats(), Adaptation::Icap::Xaction::disableRetries(), Adaptation::Icap::Xaction::handleCommTimedout(), Adaptation::Icap::Xaction::handleSecuredPeer(), mustStop(), Adaptation::Icap::Xaction::openConnection(), Adaptation::Icap::Xaction::Xaction(), ~AsyncJob(), and Adaptation::Icap::Xaction::~Xaction().

---

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

• src/base/AsyncJob.h
• src/base/AsyncJob.cc