Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Client Class Referenceabstract

#include <Client.h>

Inheritance diagram for Client:
Inheritance graph
[legend]
Collaboration diagram for Client:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< AsyncJob > Pointer
 
typedef CbcPointer< BodyProducer > Pointer
 
typedef CbcPointer< BodyConsumer > Pointer
 

Public Member Functions

 Client (FwdState *)
 
virtual ~Client ()
 
virtual const Comm::ConnectionPointer & dataConnection () const =0
 
virtual void noteMoreBodyDataAvailable (BodyPipe::Pointer)
 
virtual void noteBodyProductionEnded (BodyPipe::Pointer)
 
virtual void noteBodyProducerAborted (BodyPipe::Pointer)
 
virtual void maybeReadVirginBody ()=0
 read response data from the network More...
 
virtual void abortAll (const char *reason)=0
 abnormal transaction termination; reason is for debugging only More...
 
virtual bool abortOnData (const char *reason)
 
virtual HttpRequestPointer originalRequest ()
 a hack to reach HttpStateData::orignal_request More...
 
virtual void noteAdaptationAnswer (const Adaptation::Answer &answer)
 
virtual void noteAdaptationAclCheckDone (Adaptation::ServiceGroupPointer group)
 
virtual void noteMoreBodySpaceAvailable (BodyPipe::Pointer)
 
virtual void noteBodyConsumerAborted (BodyPipe::Pointer)
 
virtual bool getMoreRequestBody (MemBuf &buf)
 either fill buf with available [encoded] request body bytes or return false More...
 
virtual void processReplyBody ()=0
 
virtual void swanSong ()
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
void serverComplete ()
 
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...
 

Public Attributes

StoreEntry * entry = nullptr
 
FwdState::Pointer fwd
 
HttpRequestPointer request
 

Protected Member Functions

virtual void haveParsedReplyHeaders ()
 called when we have final (possibly adapted) reply headers; kids extend More...
 
virtual void completeForwarding ()
 
bool startRequestBodyFlow ()
 
void handleMoreRequestBodyAvailable ()
 
void handleRequestBodyProductionEnded ()
 
virtual void handleRequestBodyProducerAborted ()=0
 
void sendMoreRequestBody ()
 
virtual void sentRequestBody (const CommIoCbParams &io)=0
 
virtual void doneSendingRequestBody ()=0
 
virtual void closeServer ()=0
 
virtual bool doneWithServer () const =0
 
virtual bool mayReadVirginReplyBody () const =0
 whether we may receive more virgin response body bytes More...
 
bool abortOnBadEntry (const char *abortReason)
 Entry-dependent callbacks use this check to quit if the entry went bad. More...
 
bool blockCaching ()
 whether to prevent caching of an otherwise cachable response More...
 
void startAdaptation (const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
 Initiate an asynchronous adaptation transaction which will call us back. More...
 
void adaptVirginReplyBody (const char *buf, ssize_t len)
 
void cleanAdaptation ()
 
virtual bool doneWithAdaptation () const
 
void handleMoreAdaptedBodyAvailable ()
 
void handleAdaptedBodyProductionEnded ()
 
void handleAdaptedBodyProducerAborted ()
 
void handleAdaptedHeader (Http::Message *msg)
 
void handleAdaptationCompleted ()
 
void handleAdaptationBlocked (const Adaptation::Answer &answer)
 
void handleAdaptationAborted (bool bypassable=false)
 
bool handledEarlyAdaptationAbort ()
 
void resumeBodyStorage ()
 called by StoreEntry when it has more buffer space available More...
 
void endAdaptedBodyConsumption ()
 called when the entire adapted response body is consumed More...
 
const HttpReply * virginReply () const
 
HttpReply * virginReply ()
 
HttpReply * setVirginReply (HttpReply *r)
 
HttpReply * finalReply ()
 
HttpReply * setFinalReply (HttpReply *r)
 
void adaptOrFinalizeReply ()
 
void addVirginReplyBody (const char *buf, ssize_t len)
 
void storeReplyBody (const char *buf, ssize_t len)
 
size_t replyBodySpace (const MemBuf &readBuf, const size_t minSpace) const
 
size_t calcBufferSpaceToReserve (const size_t space, const size_t wantSpace) const
 determine how much space the buffer needs to reserve More...
 
void adjustBodyBytesRead (const int64_t delta)
 initializes bodyBytesRead stats if needed and applies delta 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...
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 
void stopProducingFor (RefCount< BodyPipe > &, bool atEof)
 
void stopConsumingFrom (RefCount< BodyPipe > &)
 

Protected Attributes

int64_t currentOffset = 0
 
MemBuf * responseBodyBuffer = nullptr
 
BodyPipe::Pointer requestBodySource
 
AsyncCall::Pointer requestSender
 
BodyPipe::Pointer virginBodyDestination
 
CbcPointer< Adaptation::Initiate > adaptedHeadSource
 
BodyPipe::Pointer adaptedBodySource
 
bool adaptationAccessCheckPending = false
 
bool startedAdaptation = false
 
bool receivedWholeRequestBody = false
 handleRequestBodyProductionEnded called More...
 
const char * doneWithFwd = nullptr
 
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

void serverComplete2 ()
 
void sendBodyIsTooLargeError ()
 
void maybePurgeOthers ()
 

Private Attributes

bool completed = false
 
HttpReply * theVirginReply = nullptr
 
HttpReply * theFinalReply = nullptr
 

Detailed Description

Client is a common base for classes such as HttpStateData and FtpStateData. All such classes must be able to consume request bodies from a BodyPipe or ICAP producer, adapt virgin responses using ICAP, and provide a consumer with responses.

Definition at line 29 of file Client.h.

Member Typedef Documentation

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

Constructor & Destructor Documentation

◆ Client()

Client::Client ( FwdState *  theFwdState)

Definition at line 39 of file Client.cc.

References FwdState::entry, entry, fwd, and StoreEntry::lock().

◆ ~Client()

Client::~Client ( )
virtual

Reimplemented in Ftp::Client.

Definition at line 48 of file Client.cc.

References adaptedBodySource, assert, entry, HTTPMSGUNLOCK(), NULL, requestBodySource, responseBodyBuffer, theFinalReply, theVirginReply, StoreEntry::unlock(), and virginBodyDestination.

Member Function Documentation

◆ abortAll()

virtual void Client::abortAll ( const char *  reason)
pure virtual

Implemented in Ftp::Client, and HttpStateData.

Referenced by abortOnData(), handleAdaptationAborted(), handleAdaptationBlocked(), and handledEarlyAdaptationAbort().

◆ abortOnBadEntry()

bool Client::abortOnBadEntry ( const char *  abortReason)
protected

Definition at line 234 of file Client.cc.

References abortOnData(), debugs, entry, HERE(), and StoreEntry::isAccepting().

Referenced by handleAdaptationAborted(), handleAdaptationBlocked(), handleAdaptedBodyProducerAborted(), handleAdaptedBodyProductionEnded(), handleAdaptedHeader(), handleMoreAdaptedBodyAvailable(), noteAdaptationAclCheckDone(), resumeBodyStorage(), and Ftp::Client::timeout().

◆ abortOnData()

bool Client::abortOnData ( const char *  reason)
virtual

abnormal data transfer termination

Return values
truethe transaction will be terminated (abortAll called)
falsethe transaction will survive

Reimplemented in Ftp::Relay.

Definition at line 287 of file Client.cc.

References abortAll().

Referenced by abortOnBadEntry(), Ftp::Client::dataRead(), handleAdaptationBlocked(), Ftp::Client::readControlReply(), sendBodyIsTooLargeError(), and sentRequestBody().

◆ adaptOrFinalizeReply()

void Client::adaptOrFinalizeReply ( )
protected

Definition at line 944 of file Client.cc.

References adaptationAccessCheckPending, FwdState::al, debugs, fwd, HERE(), Adaptation::methodRespmod, originalRequest(), Adaptation::pointPreCache, setFinalReply(), Adaptation::AccessCheck::Start(), and virginReply().

Referenced by Ftp::Gateway::appendSuccessHeader(), Ftp::Relay::forwardReply(), HttpStateData::processReply(), and Ftp::Relay::startDataDownload().

◆ adaptVirginReplyBody()

void Client::adaptVirginReplyBody ( const char *  buf,
ssize_t  len 
)
protected

Definition at line 594 of file Client.cc.

References MemBuf::append(), assert, MemBuf::consume(), MemBuf::content(), MemBuf::contentSize(), debugs, HERE(), MemBuf::init(), NULL, BodyPipe::putMoreData(), responseBodyBuffer, startedAdaptation, and virginBodyDestination.

Referenced by addVirginReplyBody().

◆ addVirginReplyBody()

void Client::addVirginReplyBody ( const char *  buf,
ssize_t  len 
)
protected

Definition at line 977 of file Client.cc.

References adaptationAccessCheckPending, adaptVirginReplyBody(), adjustBodyBytesRead(), assert, startedAdaptation, and storeReplyBody().

Referenced by HttpStateData::decodeAndWriteReplyBody(), noteMoreBodySpaceAvailable(), Ftp::Relay::processReplyBody(), HttpStateData::writeReplyBody(), and Ftp::Gateway::writeReplyBody().

◆ adjustBodyBytesRead()

void Client::adjustBodyBytesRead ( const int64_t  delta)
protected

Definition at line 962 of file Client.cc.

References HierarchyLogEntry::bodyBytesRead, HttpRequest::hier, Must, and originalRequest().

Referenced by addVirginReplyBody().

◆ announceInitiatorAbort()

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

Definition at line 38 of file Initiator.cc.

References CallJobHere, and Adaptation::Initiator::clearAdaptation().

Referenced by cleanAdaptation(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteInitiatorAborted(), ClientHttpRequest::~ClientHttpRequest(), and Adaptation::Initiator::~Initiator().

◆ blockCaching()

bool Client::blockCaching ( )
protected

Definition at line 518 of file Client.cc.

References SquidConfig::accessList, allow_t::allowed(), Config, debugs, entry, ACLChecklist::fastCheck(), StoreEntry::getReply(), HTTPMSGLOCK(), originalRequest(), ACLFilledChecklist::reply, and SquidConfig::storeMiss.

Referenced by setFinalReply().

◆ calcBufferSpaceToReserve()

size_t Client::calcBufferSpaceToReserve ( const size_t  space,
const size_t  wantSpace 
) const
protected

Definition at line 1002 of file Client.cc.

References BodyPipe::buf(), debugs, SBuf::maxSize, min(), NULL, MemBuf::potentialSpaceSize(), responseBodyBuffer, and virginBodyDestination.

Referenced by HttpStateData::maybeMakeSpaceAvailable().

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

◆ cleanAdaptation()

void Client::cleanAdaptation ( )
protected

Definition at line 569 of file Client.cc.

References adaptationAccessCheckPending, adaptedBodySource, adaptedHeadSource, Adaptation::Initiator::announceInitiatorAbort(), assert, debugs, doneWithAdaptation(), HERE(), NULL, BodyConsumer::stopConsumingFrom(), BodyProducer::stopProducingFor(), and virginBodyDestination.

Referenced by handleAdaptationCompleted(), and swanSong().

◆ clearAdaptation()

void Adaptation::Initiator::clearAdaptation ( CbcPointer< Initiate > &  x)
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(), noteAdaptationAnswer(), Adaptation::Icap::ServiceRep::noteAdaptationAnswer(), ClientHttpRequest::noteAdaptationAnswer(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Iterator::swanSong(), Adaptation::Icap::Launcher::swanSong(), and Adaptation::Initiator::~Initiator().

◆ closeServer()

virtual void Client::closeServer ( )
protectedpure virtual

Use this to end communication with the server. The call cancels our closure handler and tells FwdState to forget about the connection.

Implemented in Ftp::Client, and HttpStateData.

Referenced by handleAdaptationCompleted(), serverComplete(), and swanSong().

◆ completeForwarding()

void Client::completeForwarding ( )
protectedvirtual

default calls fwd->complete()

Reimplemented in Ftp::Gateway, and Ftp::Relay.

Definition at line 206 of file Client.cc.

References assert, FwdState::complete(), debugs, doneWithFwd, fwd, HERE(), and NULL.

Referenced by Ftp::Relay::completeForwarding(), Ftp::Gateway::completeForwarding(), handleAdaptationCompleted(), and serverComplete2().

◆ dataConnection()

virtual const Comm::ConnectionPointer& Client::dataConnection ( ) const
pure virtual
Returns
primary or "request data connection"

Implemented in Ftp::Client, and HttpStateData.

Referenced by sendMoreRequestBody().

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

bool Client::doneAll ( ) const
virtual

Reimplemented from AsyncJob.

Definition at line 193 of file Client.cc.

References AsyncJob::doneAll(), doneWithAdaptation(), and doneWithServer().

◆ doneSendingRequestBody()

void Client::doneSendingRequestBody ( )
protectedpure virtual

Implemented in Ftp::Client, and HttpStateData.

Definition at line 316 of file Client.cc.

References assert, debugs, HERE(), NULL, requestBodySource, and BodyConsumer::stopConsumingFrom().

Referenced by HttpStateData::doneSendingRequestBody(), Ftp::Client::doneSendingRequestBody(), handleRequestBodyProductionEnded(), and sentRequestBody().

◆ doneWithAdaptation()

bool Client::doneWithAdaptation ( ) const
protectedvirtual

did we end ICAP communication?

Definition at line 586 of file Client.cc.

References adaptationAccessCheckPending, adaptedBodySource, adaptedHeadSource, and virginBodyDestination.

Referenced by cleanAdaptation(), doneAll(), handleAdaptedHeader(), noteBodyConsumerAborted(), and serverComplete2().

◆ doneWithServer()

virtual bool Client::doneWithServer ( ) const
protectedpure virtual

did we end communication?

Implemented in Ftp::Client, and HttpStateData.

Referenced by doneAll(), serverComplete(), and swanSong().

◆ endAdaptedBodyConsumption()

void Client::endAdaptedBodyConsumption ( )
protected

Definition at line 791 of file Client.cc.

References adaptedBodySource, handleAdaptationCompleted(), and BodyConsumer::stopConsumingFrom().

Referenced by handleAdaptedBodyProductionEnded(), and resumeBodyStorage().

◆ finalReply()

HttpReply * Client::finalReply ( )
protected

Definition at line 128 of file Client.cc.

References assert, and theFinalReply.

Referenced by HttpStateData::haveParsedReplyHeaders(), and HttpStateData::reusableReply().

◆ getMoreRequestBody()

bool Client::getMoreRequestBody ( MemBuf &  buf)
virtual

Reimplemented in HttpStateData.

Definition at line 414 of file Client.cc.

References BodyPipe::getMoreData(), Must, NULL, and requestBodySource.

Referenced by HttpStateData::getMoreRequestBody(), and sendMoreRequestBody().

◆ handleAdaptationAborted()

void Client::handleAdaptationAborted ( bool  bypassable = false)
protected

Definition at line 839 of file Client.cc.

References abortAll(), abortOnBadEntry(), debugs, entry, handledEarlyAdaptationAbort(), HERE(), and StoreEntry::isEmpty().

Referenced by noteAdaptationAnswer().

◆ handleAdaptationBlocked()

void Client::handleAdaptationBlocked ( const Adaptation::Answer &  answer)
protected

Definition at line 875 of file Client.cc.

References abortAll(), abortOnBadEntry(), abortOnData(), aclGetDenyInfoPage(), FwdState::al, Config, debugs, SquidConfig::denyInfoList, HttpRequest::detailError(), ErrorState::detailError(), FwdState::dontRetry(), entry, ERR_ACCESS_DENIED, ERR_DETAIL_RESPMOD_BLOCK_EARLY, ERR_DETAIL_RESPMOD_BLOCK_LATE, ERR_ICAP_FAILURE, ERR_NONE, FwdState::fail(), fwd, RefCount< C >::getRaw(), HERE(), StoreEntry::isEmpty(), request, Adaptation::Answer::ruleId, Http::scForbidden, and String::termedBuf().

Referenced by noteAdaptationAnswer().

◆ handleAdaptationCompleted()

void Client::handleAdaptationCompleted ( )
protected

Definition at line 820 of file Client.cc.

References cleanAdaptation(), closeServer(), completeForwarding(), debugs, HERE(), and mayReadVirginReplyBody().

Referenced by endAdaptedBodyConsumption(), handleAdaptedBodyProducerAborted(), handleAdaptedHeader(), and noteBodyConsumerAborted().

◆ handleAdaptedBodyProducerAborted()

void Client::handleAdaptedBodyProducerAborted ( )
protected

Definition at line 798 of file Client.cc.

References abortOnBadEntry(), adaptedBodySource, debugs, entry, BodyPipe::exhausted(), handleAdaptationCompleted(), handledEarlyAdaptationAbort(), StoreEntry::lengthWentBad(), Must, and BodyConsumer::stopConsumingFrom().

Referenced by noteBodyProducerAborted().

◆ handleAdaptedBodyProductionEnded()

void Client::handleAdaptedBodyProductionEnded ( )
protected

Definition at line 779 of file Client.cc.

References abortOnBadEntry(), adaptedBodySource, endAdaptedBodyConsumption(), BodyPipe::exhausted(), and NULL.

Referenced by noteBodyProductionEnded().

◆ handleAdaptedHeader()

void Client::handleAdaptedHeader ( Http::Message *  msg)
protected

Definition at line 682 of file Client.cc.

References abortOnBadEntry(), adaptedBodySource, assert, Http::Message::body_pipe, debugs, doneWithAdaptation(), BodyPipe::expectNoConsumption(), handleAdaptationCompleted(), HERE(), NULL, BodyPipe::setConsumerIfNotLate(), and setFinalReply().

Referenced by noteAdaptationAnswer().

◆ handledEarlyAdaptationAbort()

bool Client::handledEarlyAdaptationAbort ( )
protected

If the store entry is still empty, fully handles adaptation abort, returning true. Otherwise just updates the request error detail and returns false.

Definition at line 855 of file Client.cc.

References abortAll(), FwdState::al, debugs, HttpRequest::detailError(), ErrorState::detailError(), FwdState::dontRetry(), entry, ERR_DETAIL_ICAP_RESPMOD_EARLY, ERR_DETAIL_ICAP_RESPMOD_LATE, ERR_ICAP_FAILURE, FwdState::fail(), fwd, RefCount< C >::getRaw(), StoreEntry::isEmpty(), request, and Http::scInternalServerError.

Referenced by handleAdaptationAborted(), and handleAdaptedBodyProducerAborted().

◆ handleMoreAdaptedBodyAvailable()

void Client::handleMoreAdaptedBodyAvailable ( )
protected

Definition at line 732 of file Client.cc.

References abortOnBadEntry(), adaptedBodySource, assert, asyncCall(), BodyPipe::buf(), StoreEntry::bytesWanted(), BodyPipe::consumedSize(), MemBuf::contentSize(), currentOffset, debugs, StoreEntry::deferProducer(), entry, HERE(), StoreIOBuffer::length, resumeBodyStorage(), and StoreEntry::write().

Referenced by noteMoreBodyDataAvailable(), and resumeBodyStorage().

◆ handleMoreRequestBodyAvailable()

void Client::handleMoreRequestBodyAvailable ( )
protected

Definition at line 295 of file Client.cc.

References debugs, HERE(), requestSender, and sendMoreRequestBody().

Referenced by noteMoreBodyDataAvailable().

◆ handleRequestBodyProducerAborted()

void Client::handleRequestBodyProducerAborted ( )
protectedpure virtual

Implemented in Ftp::Gateway, HttpStateData, and Ftp::Relay.

Definition at line 327 of file Client.cc.

References debugs, FwdState::dontRetry(), fwd, HERE(), NULL, requestBodySource, requestSender, and BodyConsumer::stopConsumingFrom().

Referenced by Ftp::Relay::handleRequestBodyProducerAborted(), HttpStateData::handleRequestBodyProducerAborted(), Ftp::Gateway::handleRequestBodyProducerAborted(), and noteBodyProducerAborted().

◆ handleRequestBodyProductionEnded()

void Client::handleRequestBodyProductionEnded ( )
protected

Definition at line 305 of file Client.cc.

References debugs, doneSendingRequestBody(), HERE(), receivedWholeRequestBody, and requestSender.

Referenced by noteBodyProductionEnded().

◆ haveParsedReplyHeaders()

void Client::haveParsedReplyHeaders ( )
protectedvirtual

called when got final headers

Reimplemented in Ftp::Gateway, and HttpStateData.

Definition at line 506 of file Client.cc.

References HttpReply::contentRange(), currentOffset, maybePurgeOthers(), Must, HttpHdrRangeSpec::offset, HttpHdrContRange::spec, and theFinalReply.

Referenced by HttpStateData::haveParsedReplyHeaders(), Ftp::Gateway::haveParsedReplyHeaders(), and setFinalReply().

◆ initiateAdaptation()

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

Definition at line 23 of file Initiator.cc.

References i, Adaptation::Initiate::initiator(), and AsyncJob::Start().

Referenced by Adaptation::Icap::Launcher::launchXaction(), startAdaptation(), ClientHttpRequest::startAdaptation(), Adaptation::Icap::ServiceRep::startGettingOptions(), Adaptation::Iterator::step(), and Adaptation::Initiator::~Initiator().

◆ 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 Adaptation::Icap::Launcher::launchXaction(), Adaptation::Icap::ServiceRep::noteAdaptationAnswer(), startAdaptation(), ClientHttpRequest::startAdaptation(), Adaptation::Iterator::step(), and Adaptation::Iterator::swanSong().

◆ maybePurgeOthers()

void Client::maybePurgeOthers ( )
private

Definition at line 485 of file Client.cc.

References SBuf::c_str(), Http::CONTENT_LOCATION, debugs, HttpRequest::effectiveRequestUri(), RefCount< C >::getRaw(), Http::LOCATION, HttpRequest::method, purgeEntriesByHeader(), purgeEntriesByUrl(), HttpRequestMethod::purgesOthers(), request, HttpReply::sline, Http::StatusLine::status(), and theFinalReply.

Referenced by haveParsedReplyHeaders().

◆ maybeReadVirginBody()

virtual void Client::maybeReadVirginBody ( )
pure virtual

Implemented in Ftp::Client, and HttpStateData.

Referenced by noteMoreBodySpaceAvailable().

◆ mayReadVirginReplyBody()

virtual bool Client::mayReadVirginReplyBody ( ) const
protectedpure virtual

Implemented in Ftp::Gateway, HttpStateData, and Ftp::Relay.

Referenced by handleAdaptationCompleted().

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

◆ noteAdaptationAclCheckDone()

void Client::noteAdaptationAclCheckDone ( Adaptation::ServiceGroupPointer  group)
virtual

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

Reimplemented from Adaptation::Initiator.

Definition at line 905 of file Client.cc.

References abortOnBadEntry(), adaptationAccessCheckPending, debugs, HERE(), originalRequest(), processReplyBody(), request, sendBodyIsTooLargeError(), setFinalReply(), startAdaptation(), and virginReply().

◆ noteAdaptationAnswer()

void Client::noteAdaptationAnswer ( const Adaptation::Answer &  answer)
virtual

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 662 of file Client.cc.

References adaptedHeadSource, Adaptation::Answer::akBlock, Adaptation::Answer::akError, Adaptation::Answer::akForward, Adaptation::Initiator::clearAdaptation(), Adaptation::Answer::final, RefCount< C >::getRaw(), handleAdaptationAborted(), handleAdaptationBlocked(), handleAdaptedHeader(), Adaptation::Answer::kind, and Adaptation::Answer::message.

◆ noteBodyConsumerAborted()

void Client::noteBodyConsumerAborted ( BodyPipe::Pointer  )
virtual

Implements BodyProducer.

Definition at line 650 of file Client.cc.

References doneWithAdaptation(), handleAdaptationCompleted(), BodyProducer::stopProducingFor(), and virginBodyDestination.

◆ noteBodyProducerAborted()

void Client::noteBodyProducerAborted ( BodyPipe::Pointer  bp)
virtual

Implements BodyConsumer.

Definition at line 274 of file Client.cc.

References adaptedBodySource, handleAdaptedBodyProducerAborted(), handleRequestBodyProducerAborted(), and requestBodySource.

◆ noteBodyProductionEnded()

void Client::noteBodyProductionEnded ( BodyPipe::Pointer  bp)
virtual

Implements BodyConsumer.

Definition at line 260 of file Client.cc.

References adaptedBodySource, handleAdaptedBodyProductionEnded(), handleRequestBodyProductionEnded(), and requestBodySource.

◆ noteMoreBodyDataAvailable()

void Client::noteMoreBodyDataAvailable ( BodyPipe::Pointer  bp)
virtual

Implements BodyConsumer.

Definition at line 246 of file Client.cc.

References adaptedBodySource, handleMoreAdaptedBodyAvailable(), handleMoreRequestBodyAvailable(), and requestBodySource.

◆ noteMoreBodySpaceAvailable()

void Client::noteMoreBodySpaceAvailable ( BodyPipe::Pointer  )
virtual

Implements BodyProducer.

Definition at line 636 of file Client.cc.

References addVirginReplyBody(), completed, maybeReadVirginBody(), NULL, responseBodyBuffer, and serverComplete2().

◆ originalRequest()

HttpRequestPointer Client::originalRequest ( )
virtual

Definition at line 535 of file Client.cc.

References request.

Referenced by adaptOrFinalizeReply(), adjustBodyBytesRead(), blockCaching(), HttpStateData::finishingBrokenPost(), HttpStateData::handle1xx(), noteAdaptationAclCheckDone(), Ftp::Gateway::readStor(), serverComplete(), and startRequestBodyFlow().

◆ processReplyBody()

virtual void Client::processReplyBody ( )
pure virtual

Implemented in Ftp::Gateway, HttpStateData, and Ftp::Relay.

Referenced by Ftp::Client::dataRead(), and noteAdaptationAclCheckDone().

◆ replyBodySpace()

size_t Client::replyBodySpace ( const MemBuf &  readBuf,
const size_t  minSpace 
) const
protected
Deprecated:
use SBuf I/O API and calcBufferSpaceToReserve() instead

Definition at line 1037 of file Client.cc.

References BodyPipe::buf(), debugs, min(), NULL, MemBuf::potentialSpaceSize(), responseBodyBuffer, MemBuf::spaceSize(), and virginBodyDestination.

Referenced by Ftp::Client::maybeReadVirginBody().

◆ resumeBodyStorage()

void Client::resumeBodyStorage ( )
protected

Definition at line 716 of file Client.cc.

References abortOnBadEntry(), adaptedBodySource, endAdaptedBodyConsumption(), BodyPipe::exhausted(), handleMoreAdaptedBodyAvailable(), and NULL.

Referenced by handleMoreAdaptedBodyAvailable().

◆ sendBodyIsTooLargeError()

void Client::sendBodyIsTooLargeError ( )
private

Definition at line 933 of file Client.cc.

References abortOnData(), FwdState::al, FwdState::dontRetry(), ERR_TOO_BIG, FwdState::fail(), fwd, RefCount< C >::getRaw(), request, and Http::scForbidden.

Referenced by noteAdaptationAclCheckDone().

◆ sendMoreRequestBody()

void Client::sendMoreRequestBody ( )
protected

Definition at line 388 of file Client.cc.

References assert, buf, conn, MemBuf::contentSize(), dataConnection(), debugs, getMoreRequestBody(), HERE(), Comm::IsConnOpen(), JobCallback, NULL, requestBodySource, requestSender, sentRequestBody(), and Comm::Write().

Referenced by handleMoreRequestBodyAvailable(), Ftp::Gateway::readStor(), and sentRequestBody().

◆ sentRequestBody()

void Client::sentRequestBody ( const CommIoCbParams &  io)
protectedpure virtual

Implemented in Ftp::Client, and HttpStateData.

Definition at line 340 of file Client.cc.

References abortOnData(), FwdState::al, StatCounters::all, DBG_IMPORTANT, debugs, doneSendingRequestBody(), EBIT_TEST, entry, ENTRY_ABORTED, Comm::ERR_CLOSING, ERR_WRITE_ERROR, BodyPipe::exhausted(), FwdState::fail(), CommCommonCbParams::fd, fd_bytes(), FD_WRITE, CommCommonCbParams::flag, StoreEntry::flags, fwd, HERE(), HttpRequest::hier, HierarchyLogEntry::notePeerWrite(), NULL, receivedWholeRequestBody, FwdState::request, request, requestBodySource, requestSender, Http::scBadGateway, sendMoreRequestBody(), StatCounters::server, CommIoCbParams::size, statCounter, CommCommonCbParams::xerrno, ErrorState::xerrno, and xstrerr().

Referenced by sendMoreRequestBody(), HttpStateData::sentRequestBody(), and Ftp::Client::sentRequestBody().

◆ serverComplete()

void Client::serverComplete ( )

call when no server communication is expected

Definition at line 156 of file Client.cc.

References assert, closeServer(), completed, debugs, doneWithServer(), HERE(), HttpRequest::hier, NULL, originalRequest(), requestBodySource, responseBodyBuffer, serverComplete2(), BodyConsumer::stopConsumingFrom(), and HierarchyLogEntry::stopPeerClock().

Referenced by ftpReadQuit(), Ftp::Gateway::loginFailed(), HttpStateData::processReplyBody(), Ftp::Gateway::processReplyBody(), Ftp::Relay::serverComplete(), and Ftp::Gateway::start().

◆ serverComplete2()

void Client::serverComplete2 ( )
private

Continuation of serverComplete

Definition at line 178 of file Client.cc.

References completeForwarding(), debugs, doneWithAdaptation(), HERE(), NULL, BodyProducer::stopProducingFor(), and virginBodyDestination.

Referenced by noteMoreBodySpaceAvailable(), and serverComplete().

◆ setFinalReply()

HttpReply * Client::setFinalReply ( HttpReply *  r)
protected

Definition at line 135 of file Client.cc.

References assert, blockCaching(), debugs, EBIT_TEST, entry, StoreEntry::flags, haveParsedReplyHeaders(), HERE(), HTTPMSGLOCK(), StoreEntry::release(), RELEASE_REQUEST, StoreEntry::replaceHttpReply(), StoreEntry::startWriting(), and theFinalReply.

Referenced by adaptOrFinalizeReply(), handleAdaptedHeader(), and noteAdaptationAclCheckDone().

◆ setVirginReply()

HttpReply * Client::setVirginReply ( HttpReply *  r)
protected

Definition at line 117 of file Client.cc.

References assert, debugs, HERE(), HTTPMSGLOCK(), and theVirginReply.

Referenced by Ftp::Gateway::appendSuccessHeader(), Ftp::Relay::forwardReply(), HttpStateData::processReplyHeader(), and Ftp::Relay::startDataDownload().

◆ 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 AsyncJob::start ( )
protectedvirtualinherited

Reimplemented in ConnStateData, Adaptation::Icap::ModXact, Ftp::Client, Ftp::Gateway, Ftp::Server, HttpStateData, Security::PeerConnector, Adaptation::Ecap::XactionRep, Http::Tunneler, Ipc::UdsSender, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Downloader, Adaptation::Icap::Xaction, Ftp::Relay, Log::TcpLogger, Adaptation::Iterator, Comm::TcpAcceptor, Ipc::Coordinator, Ipc::Forwarder, Comm::ConnOpener, Ipc::Inquirer, Http::One::Server, Rock::HeaderUpdater, Mgr::StoreToCommWriter, Rock::Rebuild, Mgr::Inquirer, PeerPoolMgr, Server, Snmp::Inquirer, Ipc::Strand, Adaptation::Icap::OptXact, Ipc::Port, Mgr::ActionWriter, and Mgr::Filler.

Definition at line 43 of file AsyncJob.cc.

Referenced by Ipc::Port::start(), PeerPoolMgr::start(), AsyncJob::Start(), Adaptation::Iterator::start(), Adaptation::Icap::Xaction::start(), Adaptation::Icap::Launcher::start(), Adaptation::AccessCheck::start(), Ipc::UdsSender::start(), Http::Tunneler::start(), Security::PeerConnector::start(), and ConnStateData::start().

◆ startAdaptation()

void Client::startAdaptation ( const Adaptation::ServiceGroupPointer &  group,
HttpRequest *  cause 
)
protected

Definition at line 543 of file Client.cc.

References adaptedHeadSource, FwdState::al, assert, Http::Message::body_pipe, debugs, HttpReply::expectingBody(), fwd, HERE(), Adaptation::Initiator::initiateAdaptation(), Adaptation::Initiator::initiated(), HttpRequest::method, Must, BodyPipe::setBodySize(), size, startedAdaptation, virginBodyDestination, and virginReply().

Referenced by noteAdaptationAclCheckDone().

◆ startRequestBodyFlow()

bool Client::startRequestBodyFlow ( )
protected

Definition at line 215 of file Client.cc.

References assert, Http::Message::body_pipe, debugs, HERE(), NULL, originalRequest(), requestBodySource, BodyPipe::setConsumerIfNotLate(), and BodyPipe::status().

Referenced by Ftp::Gateway::readStor(), HttpStateData::sendRequest(), and Ftp::Relay::startDataUpload().

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Http::Tunneler, Adaptation::Initiate, Comm::TcpAcceptor, and Ipc::Inquirer.

Definition at line 159 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by BodyPipe::buf(), AsyncJob::callEnd(), AsyncJob::callStart(), ClientRequestContext::clientAccessCheckDone(), ClientRequestContext::clientRedirectDone(), Ftp::Client::ctrlClosed(), Ftp::Relay::dataChannelConnected(), Ftp::Client::dataClosed(), Ftp::Client::dataComplete(), Ftp::Client::doneSendingRequestBody(), Ftp::Client::handleControlReply(), Ftp::Client::handleEpsvReply(), Ftp::Client::handlePasvReply(), Ftp::Client::parseControlReply(), Ftp::Relay::processReplyBody(), Ftp::Gateway::processReplyBody(), Ftp::Relay::readTransferDoneReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), Adaptation::Initiate::status(), Comm::TcpAcceptor::status(), and AsyncJob::swanSong().

◆ 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(), cleanAdaptation(), doneSendingRequestBody(), endAdaptedBodyConsumption(), ClientHttpRequest::endRequestSatisfaction(), Adaptation::Ecap::XactionRep::forgetVb(), handleAdaptedBodyProducerAborted(), handleRequestBodyProducerAborted(), BodySink::noteBodyProducerAborted(), ClientHttpRequest::noteBodyProducerAborted(), BodySink::noteBodyProductionEnded(), serverComplete(), swanSong(), Adaptation::Ecap::XactionRep::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 cleanAdaptation(), ConnStateData::finishDechunkingRequest(), Adaptation::Ecap::XactionRep::moveAbContent(), Adaptation::Ecap::XactionRep::noteBodyConsumerAborted(), noteBodyConsumerAborted(), serverComplete2(), Adaptation::Icap::ModXact::stopSending(), Adaptation::Ecap::XactionRep::swanSong(), and BodyProducer::~BodyProducer().

◆ storeReplyBody()

void Client::storeReplyBody ( const char *  buf,
ssize_t  len 
)
protected

Definition at line 993 of file Client.cc.

References currentOffset, entry, len, and StoreEntry::write().

Referenced by addVirginReplyBody().

◆ swanSong()

void Client::swanSong ( )
virtual

Reimplemented from AsyncJob.

Reimplemented in Ftp::Relay.

Definition at line 69 of file Client.cc.

References adaptedBodySource, assert, cleanAdaptation(), closeServer(), doneWithFwd, doneWithServer(), fwd, FwdState::handleUnregisteredServerEnd(), NULL, requestBodySource, BodyConsumer::stopConsumingFrom(), AsyncJob::swanSong(), and virginBodyDestination.

Referenced by Ftp::Relay::swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

◆ virginReply() [1/2]

const HttpReply * Client::virginReply ( ) const
protected

Definition at line 110 of file Client.cc.

References assert, and theVirginReply.

Referenced by adaptOrFinalizeReply(), HttpStateData::continueAfterParsingHeader(), HttpStateData::handleMoreRequestBodyAvailable(), noteAdaptationAclCheckDone(), HttpStateData::persistentConnStatus(), startAdaptation(), HttpStateData::statusIfComplete(), and HttpStateData::truncateVirginBody().

◆ virginReply() [2/2]

HttpReply * Client::virginReply ( )
protected

Definition at line 103 of file Client.cc.

References assert, and theVirginReply.

Member Data Documentation

◆ adaptationAccessCheckPending

bool Client::adaptationAccessCheckPending = false
protected

Definition at line 177 of file Client.h.

Referenced by adaptOrFinalizeReply(), addVirginReplyBody(), cleanAdaptation(), doneWithAdaptation(), noteAdaptationAclCheckDone(), Ftp::Gateway::processHeadResponse(), Ftp::Relay::processReplyBody(), HttpStateData::processReplyBody(), and Ftp::Gateway::processReplyBody().

◆ adaptedBodySource

BodyPipe::Pointer Client::adaptedBodySource
protected

to consume adated response body

Definition at line 175 of file Client.h.

Referenced by Ftp::Relay::abortOnData(), cleanAdaptation(), doneWithAdaptation(), endAdaptedBodyConsumption(), handleAdaptedBodyProducerAborted(), handleAdaptedBodyProductionEnded(), handleAdaptedHeader(), handleMoreAdaptedBodyAvailable(), noteBodyProducerAborted(), noteBodyProductionEnded(), noteMoreBodyDataAvailable(), resumeBodyStorage(), swanSong(), and ~Client().

◆ adaptedHeadSource

CbcPointer<Adaptation::Initiate> Client::adaptedHeadSource
protected

to get adapted response headers

Definition at line 174 of file Client.h.

Referenced by cleanAdaptation(), doneWithAdaptation(), noteAdaptationAnswer(), and startAdaptation().

◆ completed

bool Client::completed = false
private

serverComplete() has been called

Definition at line 86 of file Client.h.

Referenced by noteMoreBodySpaceAvailable(), and serverComplete().

◆ currentOffset

int64_t Client::currentOffset = 0
protected

Our current offset in the StoreEntry

Definition at line 160 of file Client.h.

Referenced by handleMoreAdaptedBodyAvailable(), haveParsedReplyHeaders(), and storeReplyBody().

◆ doneWithFwd

const char* Client::doneWithFwd = nullptr
protected

whether we should not be talking to FwdState; XXX: clear fwd instead points to a string literal which is used only for debugging

Definition at line 184 of file Client.h.

Referenced by completeForwarding(), Ftp::Client::ctrlClosed(), HttpStateData::httpStateConnClosed(), and swanSong().

◆ entry

StoreEntry* Client::entry = nullptr

Definition at line 164 of file Client.h.

Referenced by abortOnBadEntry(), Ftp::Gateway::appendSuccessHeader(), blockCaching(), HttpStateData::buildRequestPrefix(), Client(), Ftp::Gateway::completedListing(), HttpStateData::continueAfterParsingHeader(), Ftp::Client::dataRead(), Ftp::Relay::failed(), Ftp::Client::failed(), Ftp::Relay::failedErrorMessage(), Ftp::Relay::forwardReply(), Ftp::Gateway::ftpAcceptDataConnection(), ftpFail(), ftpSendReply(), ftpWriteTransferDone(), Ftp::Gateway::Gateway(), handleAdaptationAborted(), handleAdaptationBlocked(), handleAdaptedBodyProducerAborted(), handledEarlyAdaptationAbort(), handleMoreAdaptedBodyAvailable(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::handleRequestBodyProducerAborted(), HttpStateData::haveParsedReplyHeaders(), Ftp::Gateway::haveParsedReplyHeaders(), HttpStateData::HttpStateData(), HttpStateData::httpTimeout(), HttpStateData::keepaliveAccounting(), Ftp::Gateway::listenForDataChannel(), Ftp::Gateway::loginFailed(), Ftp::Client::maybeReadVirginBody(), Ftp::Gateway::parseListing(), HttpStateData::peerSupportsConnectionPinning(), Ftp::Gateway::processHeadResponse(), Ftp::Relay::processReplyBody(), HttpStateData::processReplyBody(), Ftp::Gateway::processReplyBody(), HttpStateData::processReplyHeader(), HttpStateData::processSurrogateControl(), Ftp::Client::readControlReply(), HttpStateData::readReply(), Ftp::Relay::Relay(), HttpStateData::reusableReply(), sentRequestBody(), setFinalReply(), Ftp::Gateway::start(), HttpStateData::statusIfComplete(), storeReplyBody(), Ftp::Client::timeout(), HttpStateData::wroteLast(), ~Client(), and Ftp::Gateway::~Gateway().

◆ fwd

FwdState::Pointer Client::fwd

Definition at line 165 of file Client.h.

Referenced by adaptOrFinalizeReply(), HttpStateData::buildRequestPrefix(), Client(), HttpStateData::closeServer(), Ftp::Client::closeServer(), Ftp::Gateway::completedListing(), completeForwarding(), Ftp::Gateway::completeForwarding(), HttpStateData::continueAfterParsingHeader(), Ftp::Client::failed(), Ftp::Relay::failedErrorMessage(), HttpStateData::finishingBrokenPost(), ftpFail(), ftpSendReply(), HttpStateData::handle1xx(), handleAdaptationBlocked(), handledEarlyAdaptationAbort(), handleRequestBodyProducerAborted(), HttpStateData::handleRequestBodyProducerAborted(), HttpStateData::haveParsedReplyHeaders(), HttpStateData::HttpStateData(), HttpStateData::httpTimeout(), Ftp::Gateway::loginFailed(), HttpStateData::processReplyBody(), Ftp::Relay::readDataReply(), HttpStateData::readReply(), Ftp::Gateway::readStor(), sendBodyIsTooLargeError(), Ftp::Relay::sendCommand(), Ftp::Client::sendPassive(), sentRequestBody(), Ftp::Relay::serverComplete(), Ftp::Gateway::start(), startAdaptation(), Ftp::Relay::startDirTracking(), Ftp::Relay::stopOriginWait(), swanSong(), Ftp::Relay::updateMaster(), HttpStateData::wroteLast(), and Ftp::Client::~Client().

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

◆ receivedWholeRequestBody

bool Client::receivedWholeRequestBody = false
protected

Definition at line 180 of file Client.h.

Referenced by HttpStateData::finishingChunkedRequest(), HttpStateData::getMoreRequestBody(), handleRequestBodyProductionEnded(), and sentRequestBody().

◆ request

HttpRequestPointer Client::request

Definition at line 166 of file Client.h.

Referenced by Ftp::Gateway::appendSuccessHeader(), HttpStateData::buildRequestPrefix(), Ftp::Gateway::buildTitleUrl(), Ftp::Gateway::checkAuth(), HttpStateData::checkDateSkew(), Ftp::Gateway::checkUrlpath(), Ftp::Gateway::completedListing(), HttpStateData::continueAfterParsingHeader(), Ftp::Relay::forwardPreliminaryReply(), ftpFail(), ftpReadType(), Ftp::Gateway::ftpRealm(), ftpSendPassive(), ftpSendReply(), ftpSendStor(), ftpSendType(), ftpSendUser(), ftpTrySlashHack(), Ftp::Gateway::Gateway(), HttpStateData::handle1xx(), handleAdaptationBlocked(), Ftp::Relay::handleControlReply(), handledEarlyAdaptationAbort(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::haveParsedReplyHeaders(), HttpStateData::HttpStateData(), HttpStateData::keepaliveAccounting(), maybePurgeOthers(), noteAdaptationAclCheckDone(), originalRequest(), HttpStateData::peerSupportsConnectionPinning(), HttpStateData::persistentConnStatus(), HttpStateData::processReplyBody(), Ftp::Gateway::processReplyBody(), HttpStateData::processReplyHeader(), HttpStateData::processSurrogateControl(), HttpStateData::readReply(), Ftp::Gateway::restartable(), HttpStateData::reusableReply(), sendBodyIsTooLargeError(), HttpStateData::sendRequest(), sentRequestBody(), Ftp::Gateway::start(), HttpStateData::statusIfComplete(), HttpStateData::truncateVirginBody(), and HttpStateData::wroteLast().

◆ requestBodySource

BodyPipe::Pointer Client::requestBodySource
protected

to consume request body

Definition at line 169 of file Client.h.

Referenced by doneSendingRequestBody(), getMoreRequestBody(), HttpStateData::getMoreRequestBody(), HttpStateData::handleMoreRequestBodyAvailable(), handleRequestBodyProducerAborted(), noteBodyProducerAborted(), noteBodyProductionEnded(), noteMoreBodyDataAvailable(), sendMoreRequestBody(), HttpStateData::sendRequest(), sentRequestBody(), serverComplete(), startRequestBodyFlow(), swanSong(), and ~Client().

◆ requestSender

AsyncCall::Pointer Client::requestSender
protected

set if we are expecting Comm::Write to call us back

Definition at line 170 of file Client.h.

Referenced by HttpStateData::finishingBrokenPost(), HttpStateData::finishingChunkedRequest(), handleMoreRequestBodyAvailable(), handleRequestBodyProducerAborted(), handleRequestBodyProductionEnded(), sendMoreRequestBody(), HttpStateData::sendRequest(), and sentRequestBody().

◆ responseBodyBuffer

MemBuf* Client::responseBodyBuffer = nullptr
protected

Data temporarily buffered for ICAP

Definition at line 161 of file Client.h.

Referenced by adaptVirginReplyBody(), calcBufferSpaceToReserve(), noteMoreBodySpaceAvailable(), replyBodySpace(), serverComplete(), and ~Client().

◆ startedAdaptation

bool Client::startedAdaptation = false
protected

Definition at line 178 of file Client.h.

Referenced by adaptVirginReplyBody(), addVirginReplyBody(), and startAdaptation().

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

◆ theFinalReply

HttpReply* Client::theFinalReply = nullptr
private

adapted reply from ICAP or virgin reply

Definition at line 191 of file Client.h.

Referenced by finalReply(), haveParsedReplyHeaders(), maybePurgeOthers(), setFinalReply(), and ~Client().

◆ theVirginReply

HttpReply* Client::theVirginReply = nullptr
private

reply received from the origin server

Definition at line 190 of file Client.h.

Referenced by setVirginReply(), virginReply(), and ~Client().

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

◆ virginBodyDestination

BodyPipe::Pointer Client::virginBodyDestination
protected

to provide virgin response body

Definition at line 173 of file Client.h.

Referenced by adaptVirginReplyBody(), calcBufferSpaceToReserve(), cleanAdaptation(), doneWithAdaptation(), noteBodyConsumerAborted(), replyBodySpace(), serverComplete2(), startAdaptation(), swanSong(), and ~Client().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors