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

#include <XactionRep.h>

Inheritance diagram for Adaptation::Ecap::XactionRep:
Inheritance graph
[legend]
Collaboration diagram for Adaptation::Ecap::XactionRep:
Collaboration graph
[legend]

Public Types

typedef libecap::shared_ptr< libecap::adapter::Xaction > AdapterXaction
 
typedef CbcPointer< AsyncJob > Pointer
 
typedef CbcPointer< BodyConsumer > Pointer
 
typedef CbcPointer< BodyProducer > Pointer
 

Public Member Functions

 XactionRep (Http::Message *virginHeader, HttpRequest *virginCause, AccessLogEntry::Pointer &alp, const Adaptation::ServicePointer &service)
 
virtual ~XactionRep ()
 
void master (const AdapterXaction &aMaster)
 
virtual const libecap::Area option (const libecap::Name &name) const
 
virtual void visitEachOption (libecap::NamedValueVisitor &visitor) const
 
virtual libecap::Message & virgin ()
 
virtual const libecap::Message & cause ()
 
virtual libecap::Message & adapted ()
 
virtual void useVirgin ()
 
virtual void useAdapted (const libecap::shared_ptr< libecap::Message > &msg)
 
virtual void blockVirgin ()
 
virtual void adaptationDelayed (const libecap::Delay &)
 
virtual void adaptationAborted ()
 
virtual void resume ()
 
virtual void vbDiscard ()
 
virtual void vbMake ()
 
virtual void vbStopMaking ()
 
virtual void vbMakeMore ()
 
virtual libecap::Area vbContent (libecap::size_type offset, libecap::size_type size)
 
virtual void vbContentShift (libecap::size_type size)
 
virtual void noteAbContentDone (bool atEnd)
 
virtual void noteAbContentAvailable ()
 
virtual void noteMoreBodySpaceAvailable (RefCount< BodyPipe > bp)
 
virtual void noteBodyConsumerAborted (RefCount< BodyPipe > bp)
 
virtual void noteMoreBodyDataAvailable (RefCount< BodyPipe > bp)
 
virtual void noteBodyProductionEnded (RefCount< BodyPipe > bp)
 
virtual void noteBodyProducerAborted (RefCount< BodyPipe > bp)
 
virtual void noteInitiatorAborted ()
 
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...
 
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
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Member Functions

Service & service ()
 
Adaptation::Message & answer ()
 
void sinkVb (const char *reason)
 
void preserveVb (const char *reason)
 
void forgetVb (const char *reason)
 
void moveAbContent ()
 
void updateHistory (Http::Message *adapted)
 
void terminateMaster ()
 
void scheduleStop (const char *reason)
 
void updateSources (Http::Message *adapted)
 
const libecap::Area clientIpValue () const
 
const libecap::Area usernameValue () const
 
const libecap::Area masterxSharedValue (const libecap::Name &name) const
 
const libecap::Area metaValue (const libecap::Name &name) const
 Return the adaptation meta header value for the given header "name". More...
 
void visitEachMetaHeader (libecap::NamedValueVisitor &visitor) const
 Return the adaptation meta headers and their values. More...
 
void doResume ()
 
void sendAnswer (const Answer &answer)
 
void tellQueryAborted (bool final)
 
void clearInitiator ()
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
void stopConsumingFrom (RefCount< BodyPipe > &)
 
void stopProducingFor (RefCount< BodyPipe > &, bool atEof)
 

Protected Attributes

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 Types

enum  OperationState {
  opUndecided,
  opOn,
  opComplete,
  opNever
}
 
typedef libecap::shared_ptr< libecap::Message > MessagePtr
 

Private Member Functions

 CBDATA_CLASS (XactionRep)
 

Private Attributes

AdapterXaction theMaster
 
Adaptation::ServicePointer theService
 xaction's adaptation service More...
 
MessageRep theVirginRep
 
MessageRep * theCauseRep
 
MessagePtr theAnswerRep
 
OperationState makingVb
 
OperationState proxyingAb
 
int adaptHistoryId
 adaptation history slot reservation More...
 
bool vbProductionFinished
 
bool abProductionFinished
 
bool abProductionAtEnd
 
AccessLogEntry::Pointer al
 Master transaction AccessLogEntry. More...
 

Detailed Description

Definition at line 32 of file XactionRep.h.

Member Typedef Documentation

◆ AdapterXaction

typedef libecap::shared_ptr<libecap::adapter::Xaction> Adaptation::Ecap::XactionRep::AdapterXaction

Definition at line 41 of file XactionRep.h.

◆ MessagePtr

typedef libecap::shared_ptr<libecap::Message> Adaptation::Ecap::XactionRep::MessagePtr
private

Definition at line 116 of file XactionRep.h.

◆ Pointer [1/3]

typedef CbcPointer<BodyProducer> BodyProducer::Pointer
inherited

Definition at line 25 of file BodyPipe.h.

◆ Pointer [2/3]

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

◆ Pointer [3/3]

typedef CbcPointer<BodyConsumer> BodyConsumer::Pointer
inherited

Definition at line 45 of file BodyPipe.h.

Member Enumeration Documentation

◆ OperationState

enum Adaptation::Ecap::XactionRep::OperationState
private
Enumerator
opUndecided 
opOn 
opComplete 
opNever 

Definition at line 119 of file XactionRep.h.

Constructor & Destructor Documentation

◆ XactionRep()

Adaptation::Ecap::XactionRep::XactionRep ( Http::Message *  virginHeader,
HttpRequest *  virginCause,
AccessLogEntry::Pointer &  alp,
const Adaptation::ServicePointer &  service 
)

Definition at line 48 of file XactionRep.cc.

References theCauseRep.

◆ ~XactionRep()

Adaptation::Ecap::XactionRep::~XactionRep ( )
virtual

Definition at line 65 of file XactionRep.cc.

References assert, theAnswerRep, theCauseRep, and theMaster.

Member Function Documentation

◆ adaptationAborted()

void Adaptation::Ecap::XactionRep::adaptationAborted ( )
virtual

Definition at line 622 of file XactionRep.cc.

References AsyncJob::mustStop(), and Adaptation::Initiate::tellQueryAborted().

◆ adaptationDelayed()

void Adaptation::Ecap::XactionRep::adaptationDelayed ( const libecap::Delay &  d)
virtual

Definition at line 614 of file XactionRep.cc.

References debugs, and HERE().

◆ adapted()

libecap::Message & Adaptation::Ecap::XactionRep::adapted ( )
virtual

Definition at line 319 of file XactionRep.cc.

References Must, and theAnswerRep.

◆ answer()

Adaptation::Message & Adaptation::Ecap::XactionRep::answer ( )
protected

Definition at line 326 of file XactionRep.cc.

References Must, Adaptation::Ecap::MessageRep::raw(), and theAnswerRep.

Referenced by moveAbContent(), noteAbContentAvailable(), noteBodyConsumerAborted(), swanSong(), and useAdapted().

◆ blockVirgin()

void Adaptation::Ecap::XactionRep::blockVirgin ( )
virtual

Definition at line 445 of file XactionRep.cc.

References Adaptation::Answer::Block(), debugs, AsyncJob::done(), HERE(), Must, NULL, opNever, opUndecided, proxyingAb, Adaptation::Initiate::sendAnswer(), service(), sinkVb(), status(), and updateHistory().

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

◆ cause()

const libecap::Message & Adaptation::Ecap::XactionRep::cause ( )
virtual

Definition at line 312 of file XactionRep.cc.

References Must, NULL, and theCauseRep.

◆ CBDATA_CLASS()

Adaptation::Ecap::XactionRep::CBDATA_CLASS ( XactionRep  )
private

◆ clearInitiator()

void Adaptation::Initiate::clearInitiator ( )
protectedinherited

Definition at line 74 of file Initiate.cc.

References CbcPointer< Cbc >::clear(), and Adaptation::Initiate::theInitiator.

Referenced by Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteInitiatorAborted(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Initiate::sendAnswer(), and Adaptation::Icap::Xaction::tellQueryAborted().

◆ clientIpValue()

const libecap::Area Adaptation::Ecap::XactionRep::clientIpValue ( ) const
protected

Definition at line 123 of file XactionRep.cc.

References HttpRequest::client_addr, Adaptation::Message::header, HttpRequest::indirect_client_addr, Ip::Address::isAnyAddr(), Ip::Address::isNoAddr(), MAX_IPSTRLEN, Must, Adaptation::Ecap::MessageRep::raw(), request(), Adaptation::Config::send_client_ip, theCauseRep, Adaptation::Ecap::TheConfig, theVirginRep, Ip::Address::toStr(), and Adaptation::Config::use_indirect_client.

Referenced by option(), and visitEachOption().

◆ 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 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 useVirgin().

◆ doneAll()

bool Adaptation::Ecap::XactionRep::doneAll ( ) const
virtual

Reimplemented from AsyncJob.

Definition at line 344 of file XactionRep.cc.

References AsyncJob::doneAll(), makingVb, opComplete, and proxyingAb.

◆ doResume()

void Adaptation::Ecap::XactionRep::doResume ( )
protected

the guts of libecap::host::Xaction::resume() API implementation which just goes async in Adaptation::Ecap::XactionRep::resume().

Definition at line 299 of file XactionRep.cc.

References Must, and theMaster.

Referenced by resume().

◆ forgetVb()

void Adaptation::Ecap::XactionRep::forgetVb ( const char *  reason)
protected

Definition at line 382 of file XactionRep.cc.

References Adaptation::Message::body_pipe, debugs, HERE(), makingVb, NULL, opComplete, opNever, opOn, opUndecided, p, Adaptation::Ecap::MessageRep::raw(), status(), BodyPipe::stillConsuming(), BodyConsumer::stopConsumingFrom(), and theVirginRep.

Referenced by preserveVb(), and sinkVb().

◆ initiator()

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

Definition at line 54 of file Initiate.cc.

References i, Must, Adaptation::Initiate::theInitiator, and CbcPointer< Cbc >::valid().

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

◆ master()

void Adaptation::Ecap::XactionRep::master ( const AdapterXaction &  aMaster)

Definition at line 73 of file XactionRep.cc.

References Must, and theMaster.

◆ masterxSharedValue()

const libecap::Area Adaptation::Ecap::XactionRep::masterxSharedValue ( const libecap::Name &  name) const
protected

Definition at line 166 of file XactionRep.cc.

References HttpRequest::adaptHistory(), Adaptation::History::getXxRecord(), Adaptation::Message::header, Must, NULL, Adaptation::Ecap::MessageRep::raw(), String::rawBuf(), request(), String::size(), theCauseRep, and theVirginRep.

Referenced by option(), and visitEachOption().

◆ metaValue()

const libecap::Area Adaptation::Ecap::XactionRep::metaValue ( const libecap::Name &  name) const
protected

Definition at line 183 of file XactionRep.cc.

References al, Adaptation::Message::header, Adaptation::Config::metaHeaders, Must, Adaptation::Ecap::MessageRep::raw(), request(), theCauseRep, theVirginRep, and SBuf::toStdString().

Referenced by option().

◆ moveAbContent()

void Adaptation::Ecap::XactionRep::moveAbContent ( )
protected

Definition at line 679 of file XactionRep.cc.

References abProductionAtEnd, abProductionFinished, answer(), debugs, HERE(), Must, opComplete, opOn, proxyingAb, BodyProducer::stopProducingFor(), and theMaster.

Referenced by noteAbContentAvailable(), noteAbContentDone(), and noteMoreBodySpaceAvailable().

◆ 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(), 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(), noteInitiatorAborted(), HttpStateData::readReply(), Comm::ConnOpener::sendAnswer(), Rock::Rebuild::start(), Security::PeerConnector::start(), HttpStateData::start(), Ipc::UdsSender::timedout(), and HttpStateData::wroteLast().

◆ noteAbContentAvailable()

void Adaptation::Ecap::XactionRep::noteAbContentAvailable ( )
virtual

Definition at line 596 of file XactionRep.cc.

References abProductionFinished, answer(), Adaptation::Message::body_pipe, moveAbContent(), Must, NULL, opOn, proxyingAb, BodyPipe::setBodySize(), and size.

◆ noteAbContentDone()

void Adaptation::Ecap::XactionRep::noteAbContentDone ( bool  atEnd)
virtual

Definition at line 586 of file XactionRep.cc.

References abProductionAtEnd, abProductionFinished, debugs, HERE(), moveAbContent(), Must, opOn, and proxyingAb.

◆ noteBodyConsumerAborted()

void Adaptation::Ecap::XactionRep::noteBodyConsumerAborted ( RefCount< BodyPipe >  bp)
virtual

Implements BodyProducer.

Definition at line 636 of file XactionRep.cc.

References answer(), Must, opComplete, opOn, proxyingAb, BodyProducer::stopProducingFor(), and theMaster.

◆ noteBodyProducerAborted()

void Adaptation::Ecap::XactionRep::noteBodyProducerAborted ( RefCount< BodyPipe >  bp)
virtual

Implements BodyConsumer.

Definition at line 663 of file XactionRep.cc.

References makingVb, Must, opOn, theMaster, and vbProductionFinished.

◆ noteBodyProductionEnded()

void Adaptation::Ecap::XactionRep::noteBodyProductionEnded ( RefCount< BodyPipe >  bp)
virtual

Implements BodyConsumer.

Definition at line 654 of file XactionRep.cc.

References makingVb, Must, opOn, theMaster, and vbProductionFinished.

◆ noteInitiatorAborted()

void Adaptation::Ecap::XactionRep::noteInitiatorAborted ( )
virtual

Implements Adaptation::Initiate.

Definition at line 672 of file XactionRep.cc.

References AsyncJob::mustStop().

◆ noteMoreBodyDataAvailable()

void Adaptation::Ecap::XactionRep::noteMoreBodyDataAvailable ( RefCount< BodyPipe >  bp)
virtual

Implements BodyConsumer.

Definition at line 646 of file XactionRep.cc.

References makingVb, Must, opOn, and theMaster.

◆ noteMoreBodySpaceAvailable()

void Adaptation::Ecap::XactionRep::noteMoreBodySpaceAvailable ( RefCount< BodyPipe >  bp)
virtual

Implements BodyProducer.

Definition at line 629 of file XactionRep.cc.

References moveAbContent(), Must, opOn, and proxyingAb.

◆ option()

const libecap::Area Adaptation::Ecap::XactionRep::option ( const libecap::Name &  name) const
virtual

Definition at line 88 of file XactionRep.cc.

References clientIpValue(), Adaptation::Config::masterx_shared_name, masterxSharedValue(), metaValue(), and usernameValue().

◆ preserveVb()

void Adaptation::Ecap::XactionRep::preserveVb ( const char *  reason)
protected

Definition at line 366 of file XactionRep.cc.

References Http::Message::body_pipe, BodyPipe::consumedSize(), debugs, forgetVb(), Adaptation::Message::header, HERE(), Must, NULL, Adaptation::Ecap::MessageRep::raw(), status(), and theVirginRep.

Referenced by useVirgin().

◆ resume()

void Adaptation::Ecap::XactionRep::resume ( )
virtual

Definition at line 287 of file XactionRep.cc.

References asyncCall(), doResume(), and ScheduleCallHere.

◆ scheduleStop()

void Adaptation::Ecap::XactionRep::scheduleStop ( const char *  reason)
protected

◆ sendAnswer()

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

Definition at line 79 of file Initiate.cc.

References Adaptation::Initiate::clearInitiator(), Adaptation::Initiator::noteAdaptationAnswer(), ScheduleCallHere, and Adaptation::Initiate::theInitiator.

Referenced by 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(), useAdapted(), and useVirgin().

◆ service()

Adaptation::Service & Adaptation::Ecap::XactionRep::service ( )
protected

Definition at line 81 of file XactionRep.cc.

References Must, NULL, and theService.

Referenced by blockVirgin(), start(), updateHistory(), and updateSources().

◆ sinkVb()

void Adaptation::Ecap::XactionRep::sinkVb ( const char *  reason)
protected

Definition at line 352 of file XactionRep.cc.

References Http::Message::body_pipe, debugs, BodyPipe::enableAutoConsumption(), forgetVb(), Adaptation::Message::header, HERE(), NULL, Adaptation::Ecap::MessageRep::raw(), status(), and theVirginRep.

Referenced by blockVirgin(), vbDiscard(), and vbStopMaking().

◆ 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(), 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(), 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 Adaptation::Ecap::XactionRep::start ( )
virtual

Reimplemented from AsyncJob.

Definition at line 225 of file XactionRep.cc.

References adaptHistoryId, HttpRequest::adaptLogHistory(), NotePairs::add(), al, Adaptation::Message::body_pipe, current_time, NotePairs::hasPair(), Adaptation::Message::header, makingVb, Adaptation::Config::metaHeaders, Adaptation::History::metaHeaders, Must, NULL, opNever, Adaptation::Ecap::MessageRep::raw(), Adaptation::History::recordXactStart(), request(), service(), theCauseRep, theMaster, and theVirginRep.

◆ status()

const char * Adaptation::Ecap::XactionRep::status ( ) const
virtual

for debugging, starts with space

Reimplemented from Adaptation::Initiate.

Definition at line 695 of file XactionRep.cc.

References MemBuf::append(), Packable::appendf(), Adaptation::Message::body_pipe, buf, MemBuf::content(), makingVb, Must, opOn, proxyingAb, Adaptation::Ecap::MessageRep::raw(), MemBuf::reset(), BodyPipe::stillConsuming(), BodyPipe::stillProducing(), MemBuf::terminate(), theAnswerRep, theVirginRep, and vbProductionFinished.

Referenced by blockVirgin(), forgetVb(), preserveVb(), sinkVb(), useAdapted(), and useVirgin().

◆ stopConsumingFrom()

void BodyConsumer::stopConsumingFrom ( RefCount< BodyPipe > &  p)
protectedinherited

Definition at line 118 of file BodyPipe.cc.

References assert, BodyPipe::clearConsumer(), debugs, and NULL.

Referenced by Ftp::Relay::abortOnData(), Adaptation::Icap::ModXact::checkConsuming(), Client::cleanAdaptation(), Client::doneSendingRequestBody(), Client::endAdaptedBodyConsumption(), ClientHttpRequest::endRequestSatisfaction(), forgetVb(), Client::handleAdaptedBodyProducerAborted(), Client::handleRequestBodyProducerAborted(), BodySink::noteBodyProducerAborted(), ClientHttpRequest::noteBodyProducerAborted(), BodySink::noteBodyProductionEnded(), Client::serverComplete(), Client::swanSong(), swanSong(), and ClientHttpRequest::~ClientHttpRequest().

◆ stopProducingFor()

void BodyProducer::stopProducingFor ( RefCount< BodyPipe > &  p,
bool  atEof 
)
protectedinherited

Definition at line 107 of file BodyPipe.cc.

References assert, BodyPipe::clearProducer(), debugs, and NULL.

Referenced by Client::cleanAdaptation(), ConnStateData::finishDechunkingRequest(), moveAbContent(), noteBodyConsumerAborted(), Client::noteBodyConsumerAborted(), Client::serverComplete2(), Adaptation::Icap::ModXact::stopSending(), swanSong(), and BodyProducer::~BodyProducer().

◆ swanSong()

void Adaptation::Ecap::XactionRep::swanSong ( )
virtual

Reimplemented from Adaptation::Initiate.

Definition at line 257 of file XactionRep.cc.

References adaptHistoryId, HttpRequest::adaptLogHistory(), answer(), Adaptation::Message::body_pipe, Adaptation::Message::header, Must, NULL, Adaptation::Ecap::MessageRep::raw(), Adaptation::History::recordXactFinish(), request(), BodyPipe::stillConsuming(), BodyPipe::stillProducing(), BodyConsumer::stopConsumingFrom(), BodyProducer::stopProducingFor(), Adaptation::Initiate::swanSong(), terminateMaster(), theAnswerRep, theCauseRep, and theVirginRep.

◆ tellQueryAborted()

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

Definition at line 87 of file Initiate.cc.

References Adaptation::Answer::Error(), and Adaptation::Initiate::sendAnswer().

Referenced by adaptationAborted(), Adaptation::Iterator::handleAdaptationError(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Initiate::swanSong(), Adaptation::Iterator::swanSong(), and Adaptation::Icap::Launcher::swanSong().

◆ terminateMaster()

void Adaptation::Ecap::XactionRep::terminateMaster ( )
protected

Definition at line 334 of file XactionRep.cc.

References theMaster.

Referenced by swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

◆ updateHistory()

void Adaptation::Ecap::XactionRep::updateHistory ( Http::Message *  adapted)
protected

Called just before sendAnswer() to record adapter meta-information which may affect answer processing and may be needed for logging.

Definition at line 461 of file XactionRep.cc.

References HttpRequest::adaptHistory(), HttpRequest::adaptLogHistory(), Adaptation::Service::cfg(), Adaptation::Message::header, hoReply, Adaptation::Config::masterx_shared_name, Must, NULL, Adaptation::Ecap::MessageRep::raw(), Adaptation::History::recordMeta(), request(), Adaptation::ServiceConfig::routing, service(), theCauseRep, theMaster, theVirginRep, Adaptation::History::updateNextServices(), and Adaptation::History::updateXxRecord().

Referenced by blockVirgin(), useAdapted(), and useVirgin().

◆ updateSources()

void Adaptation::Ecap::XactionRep::updateSources ( Http::Message *  adapted)
protected

Definition at line 738 of file XactionRep.cc.

References Adaptation::Service::cfg(), Adaptation::ServiceConfig::connectionEncryption, Adaptation::Message::header, HttpRequest::masterXaction, Must, Adaptation::Ecap::MessageRep::raw(), request(), service(), Http::Message::sources, Http::Message::srcEcap, Http::Message::srcEcaps, theCauseRep, and theVirginRep.

Referenced by useAdapted().

◆ useAdapted()

void Adaptation::Ecap::XactionRep::useAdapted ( const libecap::shared_ptr< libecap::Message > &  msg)
virtual

Definition at line 415 of file XactionRep.cc.

References answer(), Http::Message::body_pipe, debugs, Adaptation::Answer::Forward(), Adaptation::Message::header, HERE(), Must, NULL, opNever, opOn, opUndecided, proxyingAb, Adaptation::Initiate::sendAnswer(), status(), theAnswerRep, theMaster, Adaptation::Ecap::MessageRep::tieBody(), updateHistory(), and updateSources().

◆ usernameValue()

const libecap::Area Adaptation::Ecap::XactionRep::usernameValue ( ) const
protected

Definition at line 148 of file XactionRep.cc.

References HttpRequest::auth_user_request, HttpRequest::extacl_user, Adaptation::Message::header, Must, NULL, Adaptation::Ecap::MessageRep::raw(), String::rawBuf(), request(), String::size(), theCauseRep, theVirginRep, and Auth::UserRequest::username().

Referenced by option(), and visitEachOption().

◆ useVirgin()

void Adaptation::Ecap::XactionRep::useVirgin ( )
virtual

Definition at line 397 of file XactionRep.cc.

References Http::Message::body_pipe, Http::Message::clone(), debugs, AsyncJob::done(), Adaptation::Answer::Forward(), Adaptation::Message::header, HERE(), Must, opNever, opUndecided, preserveVb(), proxyingAb, Adaptation::Ecap::MessageRep::raw(), Adaptation::Initiate::sendAnswer(), status(), theVirginRep, and updateHistory().

◆ vbContent()

libecap::Area Adaptation::Ecap::XactionRep::vbContent ( libecap::size_type  offset,
libecap::size_type  size 
)
virtual

Definition at line 548 of file XactionRep.cc.

References Adaptation::Message::body_pipe, BodyPipe::buf(), MemBuf::content(), MemBuf::contentSize(), min(), Must, NULL, p, Adaptation::Ecap::MessageRep::raw(), size, and theVirginRep.

◆ vbContentShift()

void Adaptation::Ecap::XactionRep::vbContentShift ( libecap::size_type  size)
virtual

Definition at line 572 of file XactionRep.cc.

References Adaptation::Message::body_pipe, BodyPipe::buf(), BodyPipe::consume(), MemBuf::contentSize(), min(), Must, NULL, p, Adaptation::Ecap::MessageRep::raw(), size, and theVirginRep.

◆ vbDiscard()

void Adaptation::Ecap::XactionRep::vbDiscard ( )
virtual

Definition at line 510 of file XactionRep.cc.

References makingVb, Must, opNever, opUndecided, and sinkVb().

◆ vbMake()

void Adaptation::Ecap::XactionRep::vbMake ( )
virtual

Definition at line 519 of file XactionRep.cc.

References Adaptation::Message::body_pipe, makingVb, Must, NULL, opOn, opUndecided, p, Adaptation::Ecap::MessageRep::raw(), BodyPipe::setConsumerIfNotLate(), and theVirginRep.

◆ vbMakeMore()

void Adaptation::Ecap::XactionRep::vbMakeMore ( )
virtual

Definition at line 538 of file XactionRep.cc.

References Adaptation::Message::body_pipe, makingVb, BodyPipe::mayNeedMoreData(), Must, NULL, opOn, p, BodyPipe::productionEnded(), Adaptation::Ecap::MessageRep::raw(), BodyPipe::stillConsuming(), and theVirginRep.

◆ vbStopMaking()

void Adaptation::Ecap::XactionRep::vbStopMaking ( )
virtual

Definition at line 529 of file XactionRep.cc.

References makingVb, Must, opComplete, opOn, and sinkVb().

◆ virgin()

libecap::Message & Adaptation::Ecap::XactionRep::virgin ( )
virtual

Definition at line 306 of file XactionRep.cc.

References theVirginRep.

◆ visitEachMetaHeader()

void Adaptation::Ecap::XactionRep::visitEachMetaHeader ( libecap::NamedValueVisitor &  visitor) const
protected

Definition at line 207 of file XactionRep.cc.

References al, Adaptation::Message::header, Adaptation::Config::metaHeaders, Must, Adaptation::Ecap::MessageRep::raw(), request(), theCauseRep, theVirginRep, and SBuf::toStdString().

Referenced by visitEachOption().

◆ visitEachOption()

void Adaptation::Ecap::XactionRep::visitEachOption ( libecap::NamedValueVisitor &  visitor) const
virtual

Definition at line 104 of file XactionRep.cc.

References clientIpValue(), Adaptation::Config::masterx_shared_name, masterxSharedValue(), usernameValue(), and visitEachMetaHeader().

Member Data Documentation

◆ abProductionAtEnd

bool Adaptation::Ecap::XactionRep::abProductionAtEnd
private

Definition at line 125 of file XactionRep.h.

Referenced by moveAbContent(), and noteAbContentDone().

◆ abProductionFinished

bool Adaptation::Ecap::XactionRep::abProductionFinished
private

Definition at line 124 of file XactionRep.h.

Referenced by moveAbContent(), noteAbContentAvailable(), and noteAbContentDone().

◆ adaptHistoryId

int Adaptation::Ecap::XactionRep::adaptHistoryId
private

Definition at line 122 of file XactionRep.h.

Referenced by start(), and swanSong().

◆ al

AccessLogEntry::Pointer Adaptation::Ecap::XactionRep::al
private

Definition at line 126 of file XactionRep.h.

Referenced by metaValue(), start(), and visitEachMetaHeader().

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

◆ makingVb

OperationState Adaptation::Ecap::XactionRep::makingVb
private

Definition at line 120 of file XactionRep.h.

Referenced by doneAll(), forgetVb(), noteBodyProducerAborted(), noteBodyProductionEnded(), noteMoreBodyDataAvailable(), start(), status(), vbDiscard(), vbMake(), vbMakeMore(), and vbStopMaking().

◆ proxyingAb

OperationState Adaptation::Ecap::XactionRep::proxyingAb
private

Definition at line 121 of file XactionRep.h.

Referenced by blockVirgin(), doneAll(), moveAbContent(), noteAbContentAvailable(), noteAbContentDone(), noteBodyConsumerAborted(), noteMoreBodySpaceAvailable(), status(), useAdapted(), and useVirgin().

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

◆ theAnswerRep

MessagePtr Adaptation::Ecap::XactionRep::theAnswerRep
private

Definition at line 117 of file XactionRep.h.

Referenced by adapted(), answer(), status(), swanSong(), useAdapted(), and ~XactionRep().

◆ theCauseRep

MessageRep* Adaptation::Ecap::XactionRep::theCauseRep
private

Definition at line 114 of file XactionRep.h.

Referenced by cause(), clientIpValue(), masterxSharedValue(), metaValue(), start(), swanSong(), updateHistory(), updateSources(), usernameValue(), visitEachMetaHeader(), XactionRep(), and ~XactionRep().

◆ theInitiator

CbcPointer<Initiator> Adaptation::Initiate::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().

◆ theMaster

AdapterXaction Adaptation::Ecap::XactionRep::theMaster
private

Definition at line 110 of file XactionRep.h.

Referenced by doResume(), master(), moveAbContent(), noteBodyConsumerAborted(), noteBodyProducerAborted(), noteBodyProductionEnded(), noteMoreBodyDataAvailable(), start(), terminateMaster(), updateHistory(), useAdapted(), and ~XactionRep().

◆ theService

Adaptation::ServicePointer Adaptation::Ecap::XactionRep::theService
private

Definition at line 111 of file XactionRep.h.

Referenced by service().

◆ theVirginRep

MessageRep Adaptation::Ecap::XactionRep::theVirginRep
private

Definition at line 113 of file XactionRep.h.

Referenced by clientIpValue(), forgetVb(), masterxSharedValue(), metaValue(), preserveVb(), sinkVb(), start(), status(), swanSong(), updateHistory(), updateSources(), usernameValue(), useVirgin(), vbContent(), vbContentShift(), vbMake(), vbMakeMore(), virgin(), and visitEachMetaHeader().

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

◆ vbProductionFinished

bool Adaptation::Ecap::XactionRep::vbProductionFinished
private

Definition at line 123 of file XactionRep.h.

Referenced by noteBodyProducerAborted(), noteBodyProductionEnded(), and status().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors