#include <OptXact.h>
Public Types | |
| typedef CbcPointer< AsyncJob > | Pointer |
Public Member Functions | |
| OptXactLauncher (Adaptation::ServicePointer aService) | |
| void | noteInitiatorAborted () |
| virtual void | noteAdaptationAnswer (const Answer &answer) |
| virtual void | noteXactAbort (XactAbortInfo info) |
| void | initiator (const CbcPointer< Initiator > &i) |
| sets initiator More... | |
| 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 |
| virtual void | noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group) |
Static Public Member Functions | |
| static Pointer | Start (AsyncJob *job) |
| starts a freshly created job (i.e., makes the job asynchronous) More... | |
Protected Member Functions | |
| virtual Xaction * | createXaction () |
| 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 () |
| void | launchXaction (const char *xkind) |
| void | sendAnswer (const Answer &answer) |
| void | tellQueryAborted (bool final) |
| void | clearInitiator () |
| virtual const char * | status () const |
| internal cleanup; do not call directly More... | |
| void | deleteThis (const char *aReason) |
| void | mustStop (const char *aReason) |
| bool | done () const |
| the job is destroyed in callEnd() when done() More... | |
| 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... | |
Protected Attributes | |
| Adaptation::ServicePointer | theService |
| ICAP service for all launches. More... | |
| CbcPointer< Initiate > | theXaction |
| current ICAP transaction More... | |
| int | theLaunches |
| CbcPointer< Initiator > | theInitiator |
| 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... | |
Private Member Functions | |
| CBDATA_CLASS (OptXactLauncher) | |
Detailed Description
Member Typedef Documentation
◆ Pointer
|
inherited |
Definition at line 34 of file AsyncJob.h.
Constructor & Destructor Documentation
◆ OptXactLauncher()
| Adaptation::Icap::OptXactLauncher::OptXactLauncher | ( | Adaptation::ServicePointer | aService | ) |
Definition at line 140 of file OptXact.cc.
Member Function Documentation
◆ announceInitiatorAbort()
|
protectedinherited |
Definition at line 38 of file Initiator.cc.
References CallJobHere, and Adaptation::Initiator::clearAdaptation().
Referenced by Client::cleanAdaptation(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteInitiatorAborted(), ClientHttpRequest::~ClientHttpRequest(), and Adaptation::Initiator::~Initiator().
◆ 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()
|
virtualinherited |
Reimplemented in ClientHttpRequest, Adaptation::Icap::ModXact, 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()
|
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()
|
inherited |
Definition at line 101 of file AsyncJob.cc.
References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.
Referenced by AsyncJob::swanSong().
◆ CBDATA_CLASS()
|
private |
◆ clearAdaptation()
|
protectedinherited |
Definition at line 32 of file Initiator.cc.
References CbcPointer< Cbc >::clear().
Referenced by Adaptation::Initiator::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 Adaptation::Initiator::~Initiator().
◆ clearInitiator()
|
protectedinherited |
Definition at line 74 of file Initiate.cc.
References Adaptation::Initiate::theInitiator.
Referenced by Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteInitiatorAborted(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Initiate::sendAnswer(), and Adaptation::Icap::Xaction::tellQueryAborted().
◆ createXaction()
|
protectedvirtual |
Implements Adaptation::Icap::Launcher.
Definition at line 146 of file OptXact.cc.
References RefCount< C >::getRaw(), Must, NULL, and Adaptation::Icap::Launcher::theService.
◆ deleteThis()
|
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()
|
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()
|
protectedvirtualinherited |
Reimplemented from AsyncJob.
Definition at line 100 of file Launcher.cc.
References AsyncJob::doneAll(), Adaptation::Initiate::theInitiator, and Adaptation::Icap::Launcher::theXaction.
◆ initiateAdaptation()
|
protectedinherited |
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 Adaptation::Initiator::~Initiator().
◆ initiated()
|
inlineprotectedinherited |
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().
◆ initiator()
|
inherited |
Definition at line 54 of file Initiate.cc.
References i, Must, Adaptation::Initiate::theInitiator, and CbcPointer< Cbc >::valid().
Referenced by Adaptation::Initiator::initiateAdaptation().
◆ launchXaction()
|
protectedinherited |
Definition at line 43 of file Launcher.cc.
References Adaptation::Icap::Xaction::attempts, Adaptation::Icap::Xaction::clearError(), Adaptation::Icap::Launcher::createXaction(), debugs, Adaptation::Icap::Xaction::disableRepeats(), Adaptation::Icap::Xaction::disableRetries(), HERE(), Adaptation::Initiator::initiateAdaptation(), Adaptation::Initiator::initiated(), Must, Adaptation::Icap::Config::repeat_limit, Adaptation::Icap::TheConfig, Adaptation::Icap::Launcher::theLaunches, and Adaptation::Icap::Launcher::theXaction.
Referenced by Adaptation::Icap::Launcher::noteXactAbort(), and Adaptation::Icap::Launcher::start().
◆ mustStop()
|
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(), 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()
|
virtualinherited |
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 Adaptation::Initiator::~Initiator().
◆ noteAdaptationAnswer()
|
virtualinherited |
called with the initial adaptation decision (adapt, block, error); virgin and/or adapted body transmission may continue after this
Implements Adaptation::Initiator.
Definition at line 60 of file Launcher.cc.
References Adaptation::Answer::akError, Adaptation::Initiator::clearAdaptation(), debugs, AsyncJob::done(), HERE(), Adaptation::Answer::kind, Must, Adaptation::Initiate::sendAnswer(), Adaptation::Icap::Launcher::theLaunches, and Adaptation::Icap::Launcher::theXaction.
◆ noteInitiatorAborted()
|
virtualinherited |
Implements Adaptation::Initiate.
Definition at line 72 of file Launcher.cc.
References Adaptation::Initiator::announceInitiatorAbort(), Adaptation::Initiate::clearInitiator(), AsyncJob::done(), Must, and Adaptation::Icap::Launcher::theXaction.
◆ noteXactAbort()
|
virtualinherited |
Definition at line 81 of file Launcher.cc.
References Adaptation::Icap::Launcher::canRepeat(), Adaptation::Icap::Launcher::canRetry(), Adaptation::Initiator::clearAdaptation(), debugs, AsyncJob::done(), HERE(), Adaptation::Icap::Launcher::launchXaction(), Must, Adaptation::Initiate::tellQueryAborted(), Adaptation::Icap::Launcher::theLaunches, and Adaptation::Icap::Launcher::theXaction.
◆ sendAnswer()
|
protectedinherited |
Definition at line 79 of file Initiate.cc.
References Adaptation::Initiate::clearInitiator(), Adaptation::Initiator::noteAdaptationAnswer(), ScheduleCallHere, and Adaptation::Initiate::theInitiator.
Referenced by Adaptation::Ecap::XactionRep::blockVirgin(), Adaptation::Iterator::handleAdaptationBlock(), Adaptation::Iterator::handleAdaptationError(), Adaptation::Icap::OptXact::handleCommRead(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), Adaptation::Icap::ModXact::startSending(), Adaptation::Iterator::step(), Adaptation::Initiate::tellQueryAborted(), Adaptation::Ecap::XactionRep::useAdapted(), and Adaptation::Ecap::XactionRep::useVirgin().
◆ Start()
|
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(), FwdState::connectDone(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), 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(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), 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()
|
protectedvirtualinherited |
Reimplemented from AsyncJob.
Definition at line 35 of file Launcher.cc.
References Adaptation::Icap::Launcher::launchXaction(), Must, AsyncJob::start(), and Adaptation::Initiate::theInitiator.
◆ status()
|
protectedvirtualinherited |
for debugging, starts with space
Reimplemented from AsyncJob.
Reimplemented in Adaptation::Icap::Xaction, and Adaptation::Ecap::XactionRep.
Definition at line 92 of file Initiate.cc.
References AsyncJob::status().
Referenced by Adaptation::Initiate::swanSong().
◆ swanSong()
|
protectedvirtualinherited |
Reimplemented from Adaptation::Initiate.
Reimplemented in Adaptation::Icap::ModXactLauncher.
Definition at line 105 of file Launcher.cc.
References Adaptation::Initiator::clearAdaptation(), Adaptation::Initiate::swanSong(), Adaptation::Initiate::tellQueryAborted(), Adaptation::Initiate::theInitiator, and Adaptation::Icap::Launcher::theXaction.
Referenced by Adaptation::Icap::ModXactLauncher::swanSong().
◆ tellQueryAborted()
|
protectedinherited |
Definition at line 87 of file Initiate.cc.
References Adaptation::Answer::Error(), and Adaptation::Initiate::sendAnswer().
Referenced by Adaptation::Ecap::XactionRep::adaptationAborted(), Adaptation::Iterator::handleAdaptationError(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Initiate::swanSong(), Adaptation::Iterator::swanSong(), and Adaptation::Icap::Launcher::swanSong().
◆ toCbdata()
|
pure virtualinherited |
Implemented in ClientHttpRequest, HttpStateData, and BodySink.
Referenced by AsyncJob::callException(), AsyncJob::callStart(), and CbdataParent::~CbdataParent().
Member Data Documentation
◆ id
|
protectedinherited |
Definition at line 72 of file AsyncJob.h.
◆ 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
|
protectedinherited |
Definition at line 69 of file AsyncJob.h.
Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and Security::PeerConnector::status().
◆ theInitiator
|
protectedinherited |
Definition at line 51 of file Initiate.h.
Referenced by Adaptation::Initiate::clearInitiator(), Adaptation::Icap::Launcher::doneAll(), Adaptation::Initiate::initiator(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Initiate::sendAnswer(), Adaptation::Icap::Launcher::start(), Adaptation::Initiate::swanSong(), Adaptation::Iterator::swanSong(), Adaptation::Icap::Launcher::swanSong(), Adaptation::Icap::ModXact::swanSong(), and Adaptation::Icap::Xaction::tellQueryAborted().
◆ theLaunches
|
protectedinherited |
Definition at line 77 of file Launcher.h.
Referenced by Adaptation::Icap::Launcher::canRepeat(), Adaptation::Icap::Launcher::launchXaction(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), and Adaptation::Icap::Launcher::noteXactAbort().
◆ theService
|
protectedinherited |
Definition at line 75 of file Launcher.h.
Referenced by createXaction(), and Adaptation::Icap::ModXactLauncher::createXaction().
◆ theXaction
|
protectedinherited |
Definition at line 76 of file Launcher.h.
Referenced by Adaptation::Icap::Launcher::doneAll(), Adaptation::Icap::Launcher::launchXaction(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), Adaptation::Icap::Launcher::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Icap::Launcher::swanSong(), and Adaptation::Icap::Launcher::~Launcher().
◆ 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:
- src/adaptation/icap/OptXact.h
- src/adaptation/icap/OptXact.cc