Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AsyncJob Class Referenceabstract
Async-Jobs API

#include <AsyncJob.h>

Inheritance diagram for AsyncJob:
Inheritance graph
[legend]
Collaboration diagram for AsyncJob:
Collaboration graph
[legend]

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.

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(), and deleteThis().

◆ callException()

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

Reimplemented in ClientHttpRequest, Ftp::Server, Adaptation::Icap::ModXact, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, 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(), and Adaptation::Icap::Xaction::callException().

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

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall &  call) const

Definition at line 101 of file AsyncJob.cc.

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

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

Referenced by ConnStateData::connStateClosed().

◆ done()

bool AsyncJob::done ( ) const
protected

Definition at line 90 of file AsyncJob.cc.

References doneAll(), NULL, and stopReason.

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

◆ doneAll()

bool AsyncJob::doneAll ( ) const
protectedvirtual

Reimplemented in HappyConnOpener, Rock::Rebuild, Rock::HeaderUpdater, Adaptation::Icap::ModXact, ConnStateData, ClientHttpRequest, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Ipc::UdsSender, Adaptation::Ecap::XactionRep, Client, Http::Tunneler, Security::PeerConnector, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Downloader, Log::TcpLogger, Adaptation::Iterator, Ipc::Forwarder, Ipc::Inquirer, Comm::TcpAcceptor, Mgr::StoreToCommWriter, 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::HeaderUpdater::doneAll(), Comm::TcpAcceptor::doneAll(), Adaptation::Iterator::doneAll(), Log::TcpLogger::doneAll(), Downloader::doneAll(), Rock::Rebuild::doneAll(), Adaptation::Icap::Launcher::doneAll(), Security::PeerConnector::doneAll(), Adaptation::Ecap::XactionRep::doneAll(), Client::doneAll(), Ipc::UdsSender::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(), callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::drop1xx(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ start()

void AsyncJob::start ( )
protectedvirtual

Reimplemented in Ipc::Port, HappyConnOpener, Ftp::Server, Rock::Rebuild, Rock::HeaderUpdater, ConnStateData, Adaptation::Icap::ModXact, Ftp::Client, Ftp::Gateway, HttpStateData, Ipc::UdsSender, Adaptation::Ecap::XactionRep, Http::Tunneler, Security::PeerConnector, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Downloader, Adaptation::Icap::Xaction, Ftp::Relay, Log::TcpLogger, Adaptation::Iterator, Ipc::Forwarder, Comm::TcpAcceptor, Ipc::Inquirer, Ipc::Coordinator, Http::One::Server, Comm::ConnOpener, Mgr::StoreToCommWriter, Mgr::Inquirer, PeerPoolMgr, Server, Snmp::Inquirer, Ipc::Strand, Adaptation::Icap::OptXact, 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(), Security::PeerConnector::start(), Http::Tunneler::start(), Ipc::UdsSender::start(), and ConnStateData::start().

◆ 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(), FwdState::connectStart(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), FwdState::establishTunnelThruProxy(), TunnelStateData::establishTunnelThruProxy(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), HappyConnOpener::openFreshConnection(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeer(), TunnelStateData::secureConnectionToPeer(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::start(), Rock::Rebuild::Start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtual

for debugging, starts with space

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

Definition at line 159 of file AsyncJob.cc.

References buf, NULL, and stopReason.

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

◆ swanSong()

virtual void AsyncJob::swanSong ( )
inlineprotectedvirtual

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

Definition at line 54 of file AsyncJob.h.

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

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

Referenced by callException(), and callStart().

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(), callStart(), canBeCalled(), deleteThis(), and mustStop().

◆ stopReason

const char* AsyncJob::stopReason
protected

Definition at line 69 of file AsyncJob.h.

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

◆ typeName

const char* AsyncJob::typeName
protected

Definition at line 70 of file AsyncJob.h.

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

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors