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

#include <ModXact.h>

Inheritance diagram for Adaptation::Icap::ModXactLauncher:
Inheritance graph
[legend]
Collaboration diagram for Adaptation::Icap::ModXactLauncher:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

Public Member Functions

 ModXactLauncher (Http::Message *virginHeader, HttpRequest *virginCause, AccessLogEntry::Pointer &alp, Adaptation::ServicePointer s)
 
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...
 
void handleStopRequest ()
 process external request to terminate now (i.e. during this async call) More...
 
virtual void * toCbdata ()=0
 
virtual void noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group)
 

Static Public Member Functions

static void Start (const Pointer &job)
 

Public Attributes

const InstanceId< AsyncJob > id
 job identifier More...
 

Protected Member Functions

virtual Xaction * createXaction ()
 
virtual void swanSong ()
 
void updateHistory (bool start)
 starts or stops transaction accounting in ICAP history More...
 
virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
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

InOut virgin
 
AccessLogEntry::Pointer al
 
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...
 
bool started_ = false
 Start() has finished successfully. More...
 
bool swanSang_ = false
 swanSong() was called More...
 

Private Member Functions

 CBDATA_CLASS (ModXactLauncher)
 
bool canRetry (XactAbortInfo &info) const
 
bool canRepeat (XactAbortInfo &info) const
 

Detailed Description

Definition at line 378 of file ModXact.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ ModXactLauncher()

Adaptation::Icap::ModXactLauncher::ModXactLauncher ( Http::Message *  virginHeader,
HttpRequest *  virginCause,
AccessLogEntry::Pointer &  alp,
Adaptation::ServicePointer  s 
)

Definition at line 2027 of file ModXact.cc.

References Adaptation::Icap::InOut::setCause(), Adaptation::Icap::InOut::setHeader(), updateHistory(), and virgin.

Member Function Documentation

◆ announceInitiatorAbort()

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

Definition at line 38 of file Initiator.cc.

References CallJobHere.

Referenced by ClientHttpRequest::~ClientHttpRequest(), and Client::cleanAdaptation().

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 137 of file AsyncJob.cc.

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

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

◆ callException()

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

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

Definition at line 128 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall &  call)
inherited

called just before the called method

Definition at line 115 of file AsyncJob.cc.

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

◆ canBeCalled()

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

Definition at line 102 of file AsyncJob.cc.

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

◆ canRepeat()

bool Adaptation::Icap::Launcher::canRepeat ( XactAbortInfo &  info) const
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()

bool Adaptation::Icap::Launcher::canRetry ( XactAbortInfo &  info) const
privateinherited

Definition at line 116 of file Launcher.cc.

References Adaptation::Icap::XactAbortInfo::isRetriable, and shutting_down.

◆ CBDATA_CLASS()

Adaptation::Icap::ModXactLauncher::CBDATA_CLASS ( ModXactLauncher  )
private

◆ clearAdaptation()

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

Definition at line 32 of file Initiator.cc.

References CbcPointer< Cbc >::clear().

Referenced by ClientHttpRequest::handleAdaptedHeader(), ClientHttpRequest::noteAdaptationAnswer(), and Client::noteAdaptationAnswer().

◆ clearInitiator()

void Adaptation::Initiate::clearInitiator ( )
protectedinherited

Definition at line 74 of file Initiate.cc.

◆ createXaction()

Adaptation::Icap::Xaction * Adaptation::Icap::ModXactLauncher::createXaction ( )
protectedvirtual

Implements Adaptation::Icap::Launcher.

Definition at line 2037 of file ModXact.cc.

References Must, NULL, and s.

◆ deleteThis()

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

Definition at line 50 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed().

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

Definition at line 91 of file AsyncJob.cc.

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

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

◆ doneAll()

bool Adaptation::Icap::Launcher::doneAll ( ) const
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 100 of file Launcher.cc.

References AsyncJob::doneAll().

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )
inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ initiateAdaptation()

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

Definition at line 23 of file Initiator.cc.

References Adaptation::Initiate::initiator(), and Ident::Start().

Referenced by ClientHttpRequest::startAdaptation(), and Client::startAdaptation().

◆ initiated()

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

Definition at line 52 of file Initiator.h.

References CbcPointer< Cbc >::set().

Referenced by ClientHttpRequest::startAdaptation(), and Client::startAdaptation().

◆ initiator()

void Adaptation::Initiate::initiator ( const CbcPointer< Initiator > &  i)
inherited

Definition at line 54 of file Initiate.cc.

References Must, and CbcPointer< Cbc >::valid().

Referenced by Adaptation::Initiator::initiateAdaptation().

◆ launchXaction()

void Adaptation::Icap::Launcher::launchXaction ( const char *  xkind)
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()

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

Definition at line 70 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(), AsyncJob::handleStopRequest(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ noteAdaptationAclCheckDone()

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

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

Reimplemented in Client, and ClientHttpRequest.

Definition at line 17 of file Initiator.cc.

References Must.

◆ noteAdaptationAnswer()

void Adaptation::Icap::Launcher::noteAdaptationAnswer ( const Answer &  answer)
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()

void Adaptation::Icap::Launcher::noteInitiatorAborted ( )
virtualinherited

Implements Adaptation::Initiate.

Definition at line 72 of file Launcher.cc.

References Must.

◆ noteXactAbort()

void Adaptation::Icap::Launcher::noteXactAbort ( XactAbortInfo  info)
virtualinherited

Definition at line 81 of file Launcher.cc.

References debugs, HERE(), and Must.

◆ sendAnswer()

void Adaptation::Initiate::sendAnswer ( const Answer &  answer)
protectedinherited

Definition at line 79 of file Initiate.cc.

References Adaptation::Initiator::noteAdaptationAnswer(), and ScheduleCallHere.

◆ start()

void Adaptation::Icap::Launcher::start ( )
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 35 of file Launcher.cc.

References Must, and AsyncJob::start().

◆ Start()

void AsyncJob::Start ( const Pointer &  job)
staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 24 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ status()

const char * Adaptation::Initiate::status ( ) const
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()

void Adaptation::Icap::ModXactLauncher::swanSong ( )
protectedvirtual

Reimplemented from Adaptation::Icap::Launcher.

Definition at line 2045 of file ModXact.cc.

References debugs, HERE(), and Adaptation::Icap::Launcher::swanSong().

◆ tellQueryAborted()

void Adaptation::Initiate::tellQueryAborted ( bool  final)
protectedinherited

Definition at line 87 of file Initiate.cc.

References Adaptation::Answer::Error().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in HttpStateData, ClientHttpRequest, and BodySink.

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

◆ updateHistory()

void Adaptation::Icap::ModXactLauncher::updateHistory ( bool  start)
protected

Definition at line 2052 of file ModXact.cc.

References HttpRequest::icapHistory(), NULL, Adaptation::Icap::History::start(), and Adaptation::Icap::History::stop().

Referenced by ModXactLauncher().

Member Data Documentation

◆ al

AccessLogEntry::Pointer Adaptation::Icap::ModXactLauncher::al
protected

Definition at line 395 of file ModXact.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id
inherited

Definition at line 73 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

Definition at line 81 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ started_

bool AsyncJob::started_ = false
protectedinherited

Definition at line 83 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

Definition at line 79 of file AsyncJob.h.

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

◆ swanSang_

bool AsyncJob::swanSang_ = false
protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ theInitiator

CbcPointer<Initiator> Adaptation::Initiate::theInitiator
protectedinherited

Definition at line 51 of file Initiate.h.

◆ theLaunches

int Adaptation::Icap::Launcher::theLaunches
protectedinherited

Definition at line 77 of file Launcher.h.

◆ theService

Adaptation::ServicePointer Adaptation::Icap::Launcher::theService
protectedinherited

Definition at line 75 of file Launcher.h.

◆ theXaction

CbcPointer<Initiate> Adaptation::Icap::Launcher::theXaction
protectedinherited

Definition at line 76 of file Launcher.h.

◆ typeName

const char* AsyncJob::typeName
protectedinherited

Definition at line 80 of file AsyncJob.h.

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

◆ virgin

InOut Adaptation::Icap::ModXactLauncher::virgin
protected

Definition at line 393 of file ModXact.h.

Referenced by ModXactLauncher().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors