#include <ModXact.h>

Inheritance diagram for Adaptation::Icap::ModXactLauncher:

[legend]

Collaboration diagram for Adaptation::Icap::ModXactLauncher:

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

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

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

Private Member Functions
	CBDATA_CLASS (ModXactLauncher)

bool	canRetry (XactAbortInfo &info) const

bool	canRepeat (XactAbortInfo &info) const

Detailed Description

Definition at line 377 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 2023 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 Client::cleanAdaptation(), and ClientHttpRequest::~ClientHttpRequest().

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

◆ callException()

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

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()

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.

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

◆ 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(), Client::noteAdaptationAnswer(), and ClientHttpRequest::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 2033 of file ModXact.cc.

References Must, and NULL.

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

Referenced by ConnStateData::connStateClosed().

◆ done()

bool AsyncJob::done ( ) const

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()

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

protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 100 of file Launcher.cc.

References AsyncJob::doneAll().

◆ 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 Client::startAdaptation(), and ClientHttpRequest::startAdaptation().

◆ initiated()

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

inlineprotectedinherited

Definition at line 52 of file Initiator.h.

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

◆ initiator()

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

inherited

Definition at line 54 of file Initiate.cc.

References Must.

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

◆ 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 ClientHttpRequest, and Client.

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()

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(), 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 * 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 2041 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 ClientHttpRequest, HttpStateData, and BodySink.

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

◆ updateHistory()

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

protected

Definition at line 2048 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 394 of file ModXact.h.

◆ 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(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), 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(), and HappyConnOpener::status().

◆ 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 70 of file AsyncJob.h.

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

◆ virgin

InOut Adaptation::Icap::ModXactLauncher::virgin

protected

Definition at line 392 of file ModXact.h.

Referenced by ModXactLauncher().

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

src/adaptation/icap/ModXact.h
src/adaptation/icap/ModXact.cc

squid-cache.org

Optimising Web Delivery

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ ModXactLauncher()

Member Function Documentation

◆ announceInitiatorAbort()

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ canRepeat()

◆ canRetry()

◆ CBDATA_CLASS()

◆ clearAdaptation()

◆ clearInitiator()

◆ createXaction()

◆ deleteThis()

◆ done()

◆ doneAll()

◆ initiateAdaptation()

◆ initiated()

◆ initiator()

◆ launchXaction()

◆ mustStop()

◆ noteAdaptationAclCheckDone()

◆ noteAdaptationAnswer()

◆ noteInitiatorAborted()

◆ noteXactAbort()

◆ sendAnswer()

◆ start()

◆ Start()

◆ status()

◆ swanSong()

◆ tellQueryAborted()

◆ toCbdata()

◆ updateHistory()

Member Data Documentation

◆ al

◆ id

◆ inCall

◆ stopReason

◆ theInitiator

◆ theLaunches

◆ theService

◆ theXaction

◆ typeName

◆ virgin

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors