Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Adaptation::Initiator Class Referenceabstract

#include <Initiator.h>

Inheritance diagram for Adaptation::Initiator:
Inheritance graph
[legend]
Collaboration diagram for Adaptation::Initiator:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

Public Member Functions

 Initiator ()
 
virtual ~Initiator ()
 
virtual void noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group)
 
virtual void noteAdaptationAnswer (const Answer &answer)=0
 
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

CbcPointer< Initiate > initiateAdaptation (Initiate *x)
 < starts freshly created initiate and returns a safe pointer to it More...
 
void clearAdaptation (CbcPointer< Initiate > &x)
 clears the pointer (does not call announceInitiatorAbort) More...
 
void announceInitiatorAbort (CbcPointer< Initiate > &x)
 inform the transaction about abnormal termination and clear the pointer More...
 
bool initiated (const CbcPointer< AsyncJob > &job) const
 Must(initiated(initiate)) instead of Must(initiate.set()), for clarity. More...
 
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...
 

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

Definition at line 28 of file Initiator.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Initiator()

Adaptation::Initiator::Initiator ( )
inline

Definition at line 31 of file Initiator.h.

◆ ~Initiator()

virtual Adaptation::Initiator::~Initiator ( )
inlinevirtual

Definition at line 32 of file Initiator.h.

References announceInitiatorAbort(), clearAdaptation(), initiateAdaptation(), noteAdaptationAclCheckDone(), and noteAdaptationAnswer().

Member Function Documentation

◆ announceInitiatorAbort()

void Adaptation::Initiator::announceInitiatorAbort ( CbcPointer< Initiate > &  x)
protected

Definition at line 38 of file Initiator.cc.

References CallJobHere, and clearAdaptation().

Referenced by Client::cleanAdaptation(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteInitiatorAborted(), ClientHttpRequest::~ClientHttpRequest(), and ~Initiator().

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

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, AsyncJob::done(), HERE(), AsyncJob::inCall, NULL, AsyncJob::status(), AsyncJob::swanSong(), and AsyncJob::typeName.

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

◆ callException()

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

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, AsyncJob::mustStop(), and CbdataParent::toCbdata().

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall &  call)
inherited

called just before the called method

Definition at line 114 of file AsyncJob.cc.

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

Referenced by AsyncJob::swanSong().

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall &  call) const
inherited

Definition at line 101 of file AsyncJob.cc.

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

Referenced by AsyncJob::swanSong().

◆ clearAdaptation()

void Adaptation::Initiator::clearAdaptation ( CbcPointer< Initiate > &  x)
protected

Definition at line 32 of file Initiator.cc.

References CbcPointer< Cbc >::clear().

Referenced by announceInitiatorAbort(), Adaptation::Icap::ServiceRep::callException(), Adaptation::Iterator::handleAdaptationBlock(), Adaptation::Iterator::handleAdaptationError(), Adaptation::Iterator::handleAdaptedHeader(), ClientHttpRequest::handleAdaptedHeader(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), Client::noteAdaptationAnswer(), Adaptation::Icap::ServiceRep::noteAdaptationAnswer(), ClientHttpRequest::noteAdaptationAnswer(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Iterator::swanSong(), Adaptation::Icap::Launcher::swanSong(), and ~Initiator().

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

Definition at line 49 of file AsyncJob.cc.

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

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

Definition at line 90 of file AsyncJob.cc.

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

Referenced by Adaptation::Ecap::XactionRep::blockVirgin(), AsyncJob::callEnd(), Adaptation::AccessCheck::checkCandidates(), 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
protectedvirtualinherited

Reimplemented in Adaptation::Icap::ModXact, ConnStateData, ClientHttpRequest, 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 AsyncJob::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(), Client::doneAll(), Adaptation::Ecap::XactionRep::doneAll(), Security::PeerConnector::doneAll(), Adaptation::Icap::Xaction::doneAll(), Adaptation::Icap::ServiceRep::doneAll(), ClientHttpRequest::doneAll(), and ConnStateData::doneAll().

◆ initiateAdaptation()

CbcPointer< Adaptation::Initiate > Adaptation::Initiator::initiateAdaptation ( Initiate *  x)
protected

Definition at line 23 of file Initiator.cc.

References i, Adaptation::Initiate::initiator(), and AsyncJob::Start().

Referenced by Adaptation::Icap::Launcher::launchXaction(), Client::startAdaptation(), ClientHttpRequest::startAdaptation(), Adaptation::Icap::ServiceRep::startGettingOptions(), Adaptation::Iterator::step(), and ~Initiator().

◆ initiated()

bool Adaptation::Initiator::initiated ( const CbcPointer< AsyncJob > &  job) const
inlineprotected

Definition at line 52 of file Initiator.h.

References CbcPointer< Cbc >::set().

Referenced by Adaptation::Icap::Launcher::launchXaction(), Adaptation::Icap::ServiceRep::noteAdaptationAnswer(), Client::startAdaptation(), ClientHttpRequest::startAdaptation(), Adaptation::Iterator::step(), and Adaptation::Iterator::swanSong().

◆ mustStop()

void AsyncJob::mustStop ( const char *  aReason)
protectedinherited

Definition at line 69 of file AsyncJob.cc.

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

Referenced by HttpStateData::abortAll(), Ftp::Client::abortAll(), Comm::TcpAcceptor::acceptOne(), Adaptation::Ecap::XactionRep::adaptationAborted(), Adaptation::AccessCheck::callBack(), AsyncJob::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().

◆ noteAdaptationAclCheckDone()

void Adaptation::Initiator::noteAdaptationAclCheckDone ( Adaptation::ServiceGroupPointer  group)
virtual

AccessCheck calls this back with a possibly nil service group to signal whether adaptation is needed and where it should start.

Reimplemented in ClientHttpRequest, and Client.

Definition at line 17 of file Initiator.cc.

References Must.

Referenced by ~Initiator().

◆ noteAdaptationAnswer()

virtual void Adaptation::Initiator::noteAdaptationAnswer ( const Answer &  answer)
pure virtual

called with the initial adaptation decision (adapt, block, error); virgin and/or adapted body transmission may continue after this

Implemented in ClientHttpRequest, Adaptation::Icap::ServiceRep, Client, Adaptation::Icap::Launcher, and Adaptation::Iterator.

Referenced by Adaptation::Initiate::sendAnswer(), and ~Initiator().

◆ Start()

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

Definition at line 23 of file AsyncJob.cc.

References CallJobHere, and AsyncJob::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(), initiateAdaptation(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), 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 ( )
protectedvirtualinherited

Reimplemented in ConnStateData, Adaptation::Icap::ModXact, 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(), AsyncJob::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
protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Icap::ServiceRep, 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(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by BodyPipe::buf(), AsyncJob::callEnd(), AsyncJob::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 AsyncJob::swanSong().

◆ swanSong()

virtual void AsyncJob::swanSong ( )
inlineprotectedvirtualinherited

Reimplemented in Adaptation::Icap::ModXactLauncher, Adaptation::Icap::ModXact, ConnStateData, 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 AsyncJob::callEnd(), AsyncJob::callException(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::status(), and AsyncJob::~AsyncJob().

Referenced by AsyncJob::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(), and Security::PeerConnector::swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

Member Data Documentation

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

Definition at line 71 of file AsyncJob.h.

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

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

Definition at line 69 of file AsyncJob.h.

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

◆ typeName

const char* AsyncJob::typeName
protectedinherited

Definition at line 70 of file AsyncJob.h.

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

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors