#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) | |
| bool | canRetry (XactAbortInfo &info) const |
| bool | canRepeat (XactAbortInfo &info) const |
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.
Referenced by Client::cleanAdaptation(), and ClientHttpRequest::~ClientHttpRequest().
◆ 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(), and AsyncJob::deleteThis().
◆ callException()
|
virtualinherited |
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, AsyncJob::mustStop(), and CbdataParent::toCbdata().
Referenced by Ipc::Inquirer::callException(), Ipc::Forwarder::callException(), Ftp::Server::callException(), and Adaptation::Icap::Xaction::callException().
◆ 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.
◆ canBeCalled()
|
inherited |
Definition at line 101 of file AsyncJob.cc.
References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.
◆ canRepeat()
|
privateinherited |
Definition at line 123 of file Launcher.cc.
References Acl::Answer::allowed(), dash_str, debugs, ACLChecklist::fastCheck(), HERE(), HTTPMSGLOCK(), Adaptation::Icap::XactAbortInfo::icapReply, Adaptation::Icap::XactAbortInfo::icapRequest, Adaptation::Icap::XactAbortInfo::isRepeatable, Adaptation::Icap::Config::repeat, Adaptation::Icap::Config::repeat_limit, ACLFilledChecklist::reply, Http::scNone, shutting_down, HttpReply::sline, Http::StatusLine::status(), and Adaptation::Icap::TheConfig.
◆ canRetry()
|
privateinherited |
Definition at line 116 of file Launcher.cc.
References Adaptation::Icap::XactAbortInfo::isRetriable, and shutting_down.
◆ CBDATA_CLASS()
|
private |
◆ clearAdaptation()
|
protectedinherited |
Definition at line 32 of file Initiator.cc.
References CbcPointer< Cbc >::clear().
Referenced by ClientHttpRequest::handleAdaptedHeader(), Client::noteAdaptationAnswer(), and ClientHttpRequest::noteAdaptationAnswer().
◆ clearInitiator()
|
protectedinherited |
Definition at line 74 of file Initiate.cc.
◆ createXaction()
|
protectedvirtual |
Implements Adaptation::Icap::Launcher.
Definition at line 146 of file OptXact.cc.
◆ 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.
Referenced by ConnStateData::connStateClosed().
◆ done()
|
protectedinherited |
Definition at line 90 of file AsyncJob.cc.
References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.
Referenced by AsyncJob::callEnd(), HappyConnOpener::checkForNewConnection(), and Downloader::downloadFinished().
◆ doneAll()
|
protectedvirtualinherited |
Reimplemented from AsyncJob.
Definition at line 100 of file Launcher.cc.
References AsyncJob::doneAll().
◆ initiateAdaptation()
|
protectedinherited |
Definition at line 23 of file Initiator.cc.
References Adaptation::Initiate::initiator(), and Ident::Start().
Referenced by Client::startAdaptation(), and ClientHttpRequest::startAdaptation().
◆ initiated()
|
inlineprotectedinherited |
Definition at line 52 of file Initiator.h.
Referenced by Client::startAdaptation(), and ClientHttpRequest::startAdaptation().
◆ initiator()
|
inherited |
Definition at line 54 of file Initiate.cc.
References Must.
Referenced by Adaptation::Initiator::initiateAdaptation().
◆ launchXaction()
|
protectedinherited |
Definition at line 43 of file Launcher.cc.
References Adaptation::Icap::Xaction::attempts, Adaptation::Icap::Xaction::clearError(), debugs, Adaptation::Icap::Xaction::disableRepeats(), Adaptation::Icap::Xaction::disableRetries(), HERE(), Must, Adaptation::Icap::Config::repeat_limit, and Adaptation::Icap::TheConfig.
◆ 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(), AsyncJob::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().
◆ 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.
◆ 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, debugs, HERE(), Adaptation::Answer::kind, and Must.
◆ noteInitiatorAborted()
|
virtualinherited |
◆ noteXactAbort()
|
virtualinherited |
Definition at line 81 of file Launcher.cc.
◆ sendAnswer()
|
protectedinherited |
Definition at line 79 of file Initiate.cc.
References Adaptation::Initiator::noteAdaptationAnswer(), and ScheduleCallHere.
◆ start()
|
protectedvirtualinherited |
Reimplemented from AsyncJob.
Definition at line 35 of file Launcher.cc.
References Must, and AsyncJob::start().
◆ 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::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(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeer(), TunnelStateData::secureConnectionToPeer(), 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().
◆ 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().
◆ swanSong()
|
protectedvirtualinherited |
Reimplemented from Adaptation::Initiate.
Reimplemented in Adaptation::Icap::ModXactLauncher.
Definition at line 105 of file Launcher.cc.
References Adaptation::Initiate::swanSong().
Referenced by Adaptation::Icap::ModXactLauncher::swanSong().
◆ tellQueryAborted()
|
protectedinherited |
Definition at line 87 of file Initiate.cc.
References Adaptation::Answer::Error().
◆ toCbdata()
|
pure virtualinherited |
Implemented in ClientHttpRequest, HttpStateData, and BodySink.
Referenced by AsyncJob::callException(), and AsyncJob::callStart().
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(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().
◆ stopReason
|
protectedinherited |
Definition at line 69 of file AsyncJob.h.
Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().
◆ theInitiator
|
protectedinherited |
Definition at line 51 of file Initiate.h.
◆ theLaunches
|
protectedinherited |
Definition at line 77 of file Launcher.h.
◆ theService
|
protectedinherited |
Definition at line 75 of file Launcher.h.
◆ theXaction
|
protectedinherited |
Definition at line 76 of file Launcher.h.
◆ typeName
|
protectedinherited |
Definition at line 70 of file AsyncJob.h.
Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), AsyncJob::mustStop(), Adaptation::Icap::Xaction::Xaction(), and AsyncJob::~AsyncJob().
The documentation for this class was generated from the following files:
- src/adaptation/icap/OptXact.h
- src/adaptation/icap/OptXact.cc