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
Adaptation::Icap::Xaction Class Referenceabstract

#include <Xaction.h>

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

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

Public Member Functions

 Xaction (const char *aTypeName, ServiceRep::Pointer &aService)
 
virtual ~Xaction ()
 
void disableRetries ()
 
void disableRepeats (const char *reason)
 
bool retriable () const
 
bool repeatable () const
 
void noteCommConnected (const CommConnectCbParams &io)
 
void noteCommWrote (const CommIoCbParams &io)
 
void noteCommRead (const CommIoCbParams &io)
 
void noteCommTimedout (const CommTimeoutCbParams &io)
 
void noteCommClosed (const CommCloseCbParams &io)
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void clearError ()
 clear stored error details, if any; used for retries/repeats More...
 
virtual AccessLogEntry::Pointer masterLogEntry ()
 
void dnsLookupDone (const ipcache_addrs *ia)
 
ServiceRep & service ()
 
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 * 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

HttpRequest * icapRequest
 sent (or at least created) ICAP request More...
 
HttpReply::Pointer icapReply
 received ICAP reply, if any More...
 
int attempts
 the number of times we tried to get to the service, including this time More...
 

Protected Member Functions

virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual void noteInitiatorAborted ()
 
virtual void handleCommConnected ()=0
 
virtual void handleCommWrote (size_t sz)=0
 
virtual void handleCommRead (size_t sz)=0
 
virtual void handleCommTimedout ()
 
virtual void handleCommClosed ()
 
void handleSecuredPeer (Security::EncryptorAnswer &answer)
 
virtual void detailError (int)
 record error detail if possible More...
 
void openConnection ()
 
void closeConnection ()
 
void dieOnConnectionFailure ()
 
bool haveConnection () const
 
void scheduleRead ()
 
void scheduleWrite (MemBuf &buf)
 
void updateTimeout ()
 
void cancelRead ()
 
bool parseHttpMsg (Http::Message *msg)
 
bool mayReadMore () const
 
virtual bool doneReading () const
 
virtual bool doneWriting () const
 
bool doneWithIo () const
 
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...
 
virtual void fillPendingStatus (MemBuf &buf) const
 
virtual void fillDoneStatus (MemBuf &buf) const
 
virtual bool fillVirginHttpHeader (MemBuf &) const
 
void setOutcome (const XactOutcome &xo)
 
virtual void finalizeLogInfo ()
 
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...
 

Protected Attributes

Comm::ConnectionPointer connection
 ICAP server connection. More...
 
Adaptation::Icap::ServiceRep::Pointer theService
 
SBuf readBuf
 
bool commEof
 
bool reuseConnection
 
bool isRetriable
 can retry on persistent connection failures More...
 
bool isRepeatable
 can repeat if no or unsatisfactory response More...
 
bool ignoreLastWrite
 
const char * stopReason
 
AsyncCall::Pointer connector
 
AsyncCall::Pointer reader
 
AsyncCall::Pointer writer
 
AsyncCall::Pointer closer
 
AccessLogEntry::Pointer alep
 icap.log entry More...
 
AccessLogEntry & al
 short for *alep More...
 
timeval icap_tr_start
 
timeval icap_tio_start
 
timeval icap_tio_finish
 
CbcPointer< Initiator > theInitiator
 
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 tellQueryAborted ()
 
void maybeLog ()
 

Private Attributes

Comm::ConnOpener::Pointer cs
 
AsyncCall::Pointer securer
 whether we are securing a connection More...
 

Detailed Description

Definition at line 37 of file Xaction.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Xaction()

Adaptation::Icap::Xaction::Xaction ( const char *  aTypeName,
ServiceRep::Pointer &  aService 
)

Definition at line 76 of file Xaction.cc.

References current_time, debugs, HTTPMSGLOCK(), icap_tio_finish, icap_tio_start, icap_tr_start, icapRequest, XactionInitiator::initAdaptation, and AsyncJob::typeName.

◆ ~Xaction()

Adaptation::Icap::Xaction::~Xaction ( )
virtual

Definition at line 108 of file Xaction.cc.

References debugs, HTTPMSGUNLOCK(), icapRequest, and AsyncJob::typeName.

Member Function Documentation

◆ callEnd()

void Adaptation::Icap::Xaction::callEnd ( )
virtual

called right after the called job method

Reimplemented from AsyncJob.

Definition at line 408 of file Xaction.cc.

References AsyncJob::callEnd(), closeConnection(), debugs, doneWithIo(), HERE(), status(), and AsyncJob::typeName.

Referenced by detailError().

◆ callException()

void Adaptation::Icap::Xaction::callException ( const std::exception &  e)
virtual

Reimplemented from AsyncJob.

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 401 of file Xaction.cc.

References AsyncJob::callException(), Adaptation::Icap::ServiceRep::noteFailure(), service(), setOutcome(), and Adaptation::Icap::xoError.

Referenced by Adaptation::Icap::ModXact::callException(), and detailError().

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

◆ cancelRead()

void Adaptation::Icap::Xaction::cancelRead ( )
protected

Definition at line 513 of file Xaction.cc.

References connection, Comm::Connection::fd, haveConnection(), Must, NULL, Comm::ReadCancel(), and reader.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), closeConnection(), and detailError().

◆ clearError()

virtual void Adaptation::Icap::Xaction::clearError ( )
inlinevirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 113 of file Xaction.h.

References dnsLookupDone(), finalizeLogInfo(), masterLogEntry(), maybeLog(), service(), setOutcome(), and tellQueryAborted().

Referenced by Adaptation::Icap::Launcher::launchXaction().

◆ 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(), noteInitiatorAborted(), Adaptation::Initiate::sendAnswer(), and tellQueryAborted().

◆ closeConnection()

void Adaptation::Icap::Xaction::closeConnection ( )
protected

Definition at line 244 of file Xaction.cc.

References al, cancelRead(), closer, comm_remove_close_handler(), connection, connector, debugs, disableRetries(), doneWithIo(), Comm::Connection::fd, haveConnection(), HERE(), AccessLogEntry::icap, NULL, AccessLogEntry::IcapLogEntry::outcome, reader, reuseConnection, service(), status(), writer, Adaptation::Icap::xoError, and Adaptation::Icap::xoGone.

Referenced by callEnd(), detailError(), handleCommTimedout(), and swanSong().

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

◆ detailError()

virtual void Adaptation::Icap::Xaction::detailError ( int  )
inlineprotectedvirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 76 of file Xaction.h.

References buf, callEnd(), callException(), cancelRead(), closeConnection(), dieOnConnectionFailure(), doneAll(), doneReading(), doneWithIo(), doneWriting(), fillDoneStatus(), fillPendingStatus(), fillVirginHttpHeader(), haveConnection(), mayReadMore(), openConnection(), parseHttpMsg(), scheduleRead(), scheduleWrite(), status(), swanSong(), and updateTimeout().

Referenced by dieOnConnectionFailure(), handleCommClosed(), handleSecuredPeer(), and noteInitiatorAborted().

◆ dieOnConnectionFailure()

void Adaptation::Icap::Xaction::dieOnConnectionFailure ( )
protected

Definition at line 322 of file Xaction.cc.

References debugs, detailError(), ERR_DETAIL_ICAP_XACT_START, HERE(), Adaptation::Icap::ServiceRep::noteConnectionFailed(), service(), TexcHere, and AsyncJob::typeName.

Referenced by detailError(), dnsLookupDone(), and noteCommConnected().

◆ disableRepeats()

void Adaptation::Icap::Xaction::disableRepeats ( const char *  reason)

Definition at line 136 of file Xaction.cc.

References debugs, isRepeatable, status(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::ModXact::echoMore(), Adaptation::Icap::Launcher::launchXaction(), Adaptation::Icap::ModXact::noteServiceReady(), Adaptation::Icap::ModXact::parseBody(), Adaptation::Icap::ModXact::prepEchoing(), Adaptation::Icap::ModXact::startSending(), Adaptation::Icap::ModXact::virginConsume(), and Adaptation::Icap::ModXact::waitForService().

◆ disableRetries()

void Adaptation::Icap::Xaction::disableRetries ( )

Definition at line 129 of file Xaction.cc.

References debugs, isRetriable, status(), and AsyncJob::typeName.

Referenced by closeConnection(), Adaptation::Icap::ModXact::decideOnRetries(), Adaptation::Icap::Launcher::launchXaction(), noteCommRead(), Adaptation::Icap::ModXact::noteServiceReady(), openConnection(), and Adaptation::Icap::ModXact::waitForService().

◆ dnsLookupDone()

void Adaptation::Icap::Xaction::dnsLookupDone ( const ipcache_addrs *  ia)

Definition at line 194 of file Xaction.cc.

References asyncCall(), Adaptation::Service::cfg(), Comm::COMM_ERROR, Adaptation::Icap::Config::connect_timeout(), connection, connector, cs, Dns::CachedIps::current(), data, DBG_IMPORTANT, debugs, dieOnConnectionFailure(), CbcPointer< Cbc >::get(), getOutgoingAddress(), HERE(), Adaptation::ServiceConfig::host, JobCallback, noteCommConnected(), NULL, Comm::OK, Adaptation::ServiceConfig::port, Ip::Address::port(), Comm::Connection::remote, ScheduleCallHere, service(), AsyncJob::Start(), String::termedBuf(), and Adaptation::Icap::TheConfig.

Referenced by clearError(), and icapLookupDnsResults().

◆ 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 Adaptation::Icap::Xaction::doneAll ( ) const
protectedvirtual

Reimplemented from AsyncJob.

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 417 of file Xaction.cc.

References connector, AsyncJob::doneAll(), reader, securer, and writer.

Referenced by detailError(), and Adaptation::Icap::ModXact::doneAll().

◆ doneReading()

bool Adaptation::Icap::Xaction::doneReading ( ) const
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Definition at line 549 of file Xaction.cc.

References commEof.

Referenced by detailError(), doneWithIo(), and mayReadMore().

◆ doneWithIo()

bool Adaptation::Icap::Xaction::doneWithIo ( ) const
protected

Definition at line 559 of file Xaction.cc.

References connector, doneReading(), doneWriting(), haveConnection(), reader, and writer.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), callEnd(), closeConnection(), and detailError().

◆ doneWriting()

bool Adaptation::Icap::Xaction::doneWriting ( ) const
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 554 of file Xaction.cc.

References writer.

Referenced by detailError(), and doneWithIo().

◆ fillDoneStatus()

void Adaptation::Icap::Xaction::fillDoneStatus ( MemBuf &  buf) const
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 692 of file Xaction.cc.

References MemBuf::append(), Packable::appendf(), commEof, connection, Comm::Connection::fd, haveConnection(), NULL, and stopReason.

Referenced by detailError(), Adaptation::Icap::ModXact::fillDoneStatus(), and status().

◆ fillPendingStatus()

void Adaptation::Icap::Xaction::fillPendingStatus ( MemBuf &  buf) const
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 677 of file Xaction.cc.

References MemBuf::append(), Packable::appendf(), connection, Comm::Connection::fd, haveConnection(), NULL, reader, and writer.

Referenced by detailError(), Adaptation::Icap::ModXact::fillPendingStatus(), and status().

◆ fillVirginHttpHeader()

bool Adaptation::Icap::Xaction::fillVirginHttpHeader ( MemBuf &  ) const
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 701 of file Xaction.cc.

Referenced by detailError().

◆ finalizeLogInfo()

void Adaptation::Icap::Xaction::finalizeLogInfo ( )
protectedvirtual

Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Definition at line 640 of file Xaction.cc.

References al, Adaptation::Service::cfg(), current_time, RefCount< C >::getRaw(), Adaptation::ServiceConfig::host, AccessLogEntry::IcapLogEntry::hostAddr, HTTPMSGLOCK(), AccessLogEntry::icap, icap_tio_finish, icap_tio_start, icap_tr_start, icapReply, icapRequest, AccessLogEntry::icp, ICP_INVALID, AccessLogEntry::IcapLogEntry::ioTime, Adaptation::ServiceConfig::key, NULL, AccessLogEntry::IcpDetails::opcode, AccessLogEntry::IcapLogEntry::reply, AccessLogEntry::IcapLogEntry::request, AccessLogEntry::IcapLogEntry::reqUri, AccessLogEntry::IcapLogEntry::resStatus, service(), AccessLogEntry::IcapLogEntry::serviceName, HttpReply::sline, Http::StatusLine::status(), String::termedBuf(), AccessLogEntry::IcapLogEntry::trTime, tvSub(), and Adaptation::ServiceConfig::uri.

Referenced by clearError(), Adaptation::Icap::OptXact::finalizeLogInfo(), Adaptation::Icap::ModXact::finalizeLogInfo(), and maybeLog().

◆ handleCommClosed()

void Adaptation::Icap::Xaction::handleCommClosed ( )
protectedvirtual

Definition at line 395 of file Xaction.cc.

References detailError(), ERR_DETAIL_ICAP_XACT_CLOSE, and AsyncJob::mustStop().

Referenced by noteCommClosed().

◆ handleCommConnected()

virtual void Adaptation::Icap::Xaction::handleCommConnected ( )
protectedpure virtual

Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Referenced by handleSecuredPeer(), and noteCommConnected().

◆ handleCommRead()

virtual void Adaptation::Icap::Xaction::handleCommRead ( size_t  sz)
protectedpure virtual

Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Referenced by noteCommRead().

◆ handleCommTimedout()

void Adaptation::Icap::Xaction::handleCommTimedout ( )
protectedvirtual

Definition at line 367 of file Xaction.cc.

References assert, closeConnection(), connector, debugs, haveConnection(), HERE(), NULL, reuseConnection, status(), TexcHere, theService, and AsyncJob::typeName.

Referenced by noteCommConnected(), and noteCommTimedout().

◆ handleCommWrote()

virtual void Adaptation::Icap::Xaction::handleCommWrote ( size_t  sz)
protectedpure virtual

Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Referenced by noteCommWrote().

◆ handleSecuredPeer()

void Adaptation::Icap::Xaction::handleSecuredPeer ( Security::EncryptorAnswer &  answer)
protected

Definition at line 738 of file Xaction.cc.

References AsyncCall::cancel(), Comm::Connection::close(), closer, comm_remove_close_handler(), Security::EncryptorAnswer::conn, debugs, detailError(), ERR_DETAIL_ICAP_XACT_SSL_START, Security::EncryptorAnswer::error, Comm::Connection::fd, CbcPointer< Cbc >::get(), handleCommConnected(), Comm::IsConnOpen(), Must, Adaptation::Icap::ServiceRep::noteConnectionFailed(), Adaptation::Icap::ServiceRep::noteConnectionUse(), NULL, securer, service(), TexcHere, and AsyncJob::typeName.

Referenced by noteCommConnected().

◆ haveConnection()

bool Adaptation::Icap::Xaction::haveConnection ( ) const
protected

Definition at line 566 of file Xaction.cc.

References connection, Comm::Connection::isOpen(), and NULL.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), cancelRead(), closeConnection(), detailError(), doneWithIo(), fillDoneStatus(), fillPendingStatus(), Adaptation::Icap::ModXact::fillPendingStatus(), handleCommTimedout(), openConnection(), scheduleRead(), scheduleWrite(), Adaptation::Icap::ModXact::startReading(), and updateTimeout().

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

◆ masterLogEntry()

AccessLogEntry::Pointer Adaptation::Icap::Xaction::masterLogEntry ( )
virtual

Reimplemented in Adaptation::Icap::ModXact.

Definition at line 116 of file Xaction.cc.

References Store::nil.

Referenced by clearError(), and noteCommConnected().

◆ maybeLog()

void Adaptation::Icap::Xaction::maybeLog ( )
private

Definition at line 632 of file Xaction.cc.

References alep, finalizeLogInfo(), IcapLogfileStatus, icapLogLog(), and LOG_ENABLE.

Referenced by clearError(), and swanSong().

◆ mayReadMore()

bool Adaptation::Icap::Xaction::mayReadMore ( ) const
protected

Definition at line 543 of file Xaction.cc.

References doneReading(), SBuf::length(), and readBuf.

Referenced by detailError(), Adaptation::Icap::ModXact::parseBody(), Adaptation::Icap::ModXact::parseHeaders(), and parseHttpMsg().

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

◆ noteCommClosed()

void Adaptation::Icap::Xaction::noteCommClosed ( const CommCloseCbParams &  io)

Definition at line 385 of file Xaction.cc.

References AsyncCall::cancel(), closer, handleCommClosed(), NULL, and securer.

Referenced by noteCommConnected(), and repeatable().

◆ noteCommConnected()

void Adaptation::Icap::Xaction::noteCommConnected ( const CommConnectCbParams &  io)

Definition at line 278 of file Xaction.cc.

References asyncCall(), closer, comm_add_close_handler(), commSetConnTimeout(), CommCommonCbParams::conn, Adaptation::Icap::Config::connect_timeout(), connection, connector, cs, dieOnConnectionFailure(), Comm::Connection::fd, fd_table, CommCommonCbParams::flag, handleCommConnected(), handleCommTimedout(), handleSecuredPeer(), masterLogEntry(), Must, noteCommClosed(), noteCommTimedout(), Adaptation::Icap::ServiceRep::noteConnectionUse(), NULL, Comm::OK, securer, service(), AsyncJob::Start(), Adaptation::Icap::TheConfig, theService, and Comm::TIMEOUT.

Referenced by dnsLookupDone(), openConnection(), and repeatable().

◆ noteCommRead()

void Adaptation::Icap::Xaction::noteCommRead ( const CommIoCbParams &  io)

Definition at line 453 of file Xaction.cc.

References al, AccessLogEntry::IcapLogEntry::bytesRead, commEof, CommCommonCbParams::conn, debugs, disableRetries(), Comm::ENDFILE, CommCommonCbParams::flag, handleCommRead(), AccessLogEntry::icap, Comm::INPROGRESS, SBuf::isEmpty(), SBuf::length(), Must, AsyncJob::mustStop(), NULL, Comm::OK, SBuf::rawAppendStart(), readBuf, reader, Comm::ReadNow(), SBuf::reserveCapacity(), retriable(), reuseConnection, scheduleRead(), setOutcome(), CommIoCbParams::size, updateTimeout(), CommCommonCbParams::xerrno, Adaptation::Icap::xoRace, and xstrerr().

Referenced by repeatable(), and scheduleRead().

◆ noteCommTimedout()

void Adaptation::Icap::Xaction::noteCommTimedout ( const CommTimeoutCbParams &  io)

Definition at line 362 of file Xaction.cc.

References handleCommTimedout().

Referenced by noteCommConnected(), repeatable(), and updateTimeout().

◆ noteCommWrote()

void Adaptation::Icap::Xaction::noteCommWrote ( const CommIoCbParams &  io)

Definition at line 344 of file Xaction.cc.

References al, AccessLogEntry::IcapLogEntry::bytesSent, debugs, CommCommonCbParams::flag, handleCommWrote(), HERE(), AccessLogEntry::icap, ignoreLastWrite, Must, NULL, Comm::OK, CommIoCbParams::size, updateTimeout(), and writer.

Referenced by repeatable(), and scheduleWrite().

◆ noteInitiatorAborted()

void Adaptation::Icap::Xaction::noteInitiatorAborted ( )
protectedvirtual

Implements Adaptation::Initiate.

Definition at line 572 of file Xaction.cc.

References Adaptation::Initiate::clearInitiator(), debugs, detailError(), ERR_DETAIL_ICAP_INIT_GONE, HERE(), AsyncJob::mustStop(), CbcPointer< Cbc >::set(), setOutcome(), Adaptation::Initiate::theInitiator, and Adaptation::Icap::xoGone.

◆ openConnection()

void Adaptation::Icap::Xaction::openConnection ( )
protected

Definition at line 157 of file Xaction.cc.

References asyncCall(), Adaptation::Service::cfg(), connection, connector, debugs, disableRetries(), Adaptation::Icap::ServiceRep::getConnection(), haveConnection(), Adaptation::ServiceConfig::host, icapLookupDnsResults(), ipcache_nbgethostbyname(), Comm::IsConnOpen(), isRetriable, Must, noteCommConnected(), Comm::OK, Adaptation::ServiceConfig::port, Adaptation::Icap::Config::reuse_connections, ScheduleCallHere, service(), String::termedBuf(), Adaptation::Icap::TheConfig, and AsyncJob::typeName.

Referenced by detailError(), Adaptation::Icap::OptXact::start(), and Adaptation::Icap::ModXact::startWriting().

◆ parseHttpMsg()

bool Adaptation::Icap::Xaction::parseHttpMsg ( Http::Message *  msg)
protected

Definition at line 523 of file Xaction.cc.

References buf, SBuf::c_str(), commEof, SBuf::consume(), debugs, error(), Http::Message::hdr_sz, SBuf::length(), mayReadMore(), Must, Http::Message::parse(), readBuf, Http::Message::reset(), and Http::scNone.

Referenced by detailError(), and Adaptation::Icap::OptXact::parseResponse().

◆ repeatable()

bool Adaptation::Icap::Xaction::repeatable ( ) const
inline

Definition at line 47 of file Xaction.h.

References isRepeatable, noteCommClosed(), noteCommConnected(), noteCommRead(), noteCommTimedout(), and noteCommWrote().

Referenced by tellQueryAborted().

◆ retriable()

bool Adaptation::Icap::Xaction::retriable ( ) const
inline

Definition at line 46 of file Xaction.h.

References isRetriable.

Referenced by noteCommRead(), and tellQueryAborted().

◆ scheduleRead()

void Adaptation::Icap::Xaction::scheduleRead ( )
protected

Definition at line 440 of file Xaction.cc.

References connection, haveConnection(), JobCallback, SBuf::length(), Must, noteCommRead(), Comm::Read(), readBuf, reader, and updateTimeout().

Referenced by detailError(), Adaptation::Icap::OptXact::handleCommConnected(), Adaptation::Icap::OptXact::handleCommRead(), noteCommRead(), and Adaptation::Icap::ModXact::readMore().

◆ scheduleWrite()

void Adaptation::Icap::Xaction::scheduleWrite ( MemBuf &  buf)
protected

Definition at line 331 of file Xaction.cc.

References connection, haveConnection(), JobCallback, Must, noteCommWrote(), updateTimeout(), Comm::Write(), and writer.

Referenced by detailError(), Adaptation::Icap::OptXact::handleCommConnected(), Adaptation::Icap::ModXact::handleCommConnected(), and Adaptation::Icap::ModXact::writeSomeBody().

◆ 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 Adaptation::Ecap::XactionRep::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(), Adaptation::Ecap::XactionRep::useAdapted(), and Adaptation::Ecap::XactionRep::useVirgin().

◆ service()

Adaptation::Icap::ServiceRep & Adaptation::Icap::Xaction::service ( )

Definition at line 123 of file Xaction.cc.

References Must, NULL, and theService.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), callException(), clearError(), closeConnection(), Adaptation::Icap::ConnWaiterDialer::ConnWaiterDialer(), Adaptation::Icap::ModXact::decideOnPreview(), dieOnConnectionFailure(), dnsLookupDone(), finalizeLogInfo(), Adaptation::Icap::ModXact::finalizeLogInfo(), handleSecuredPeer(), Adaptation::Icap::OptXact::makeRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Icap::ModXact::maybeAllocateHttpMsg(), noteCommConnected(), Adaptation::Icap::ModXact::noteServiceAvailable(), Adaptation::Icap::ModXact::noteServiceReady(), openConnection(), Adaptation::Icap::ModXact::parseIcapHead(), Adaptation::Icap::ModXact::shouldAllow204(), Adaptation::Icap::ModXact::shouldAllow206any(), Adaptation::Icap::ModXact::start(), swanSong(), updateTimeout(), Adaptation::Icap::ModXact::validate200Ok(), and Adaptation::Icap::ModXact::waitForService().

◆ setOutcome()

void Adaptation::Icap::Xaction::setOutcome ( const XactOutcome &  xo)
protected

Definition at line 585 of file Xaction.cc.

References al, debugs, HERE(), AccessLogEntry::icap, AccessLogEntry::IcapLogEntry::outcome, and Adaptation::Icap::xoUnknown.

Referenced by callException(), clearError(), Adaptation::Icap::OptXact::handleCommRead(), Adaptation::Icap::ModXact::maybeAllocateHttpMsg(), noteCommRead(), noteInitiatorAborted(), Adaptation::Icap::ModXact::prepEchoing(), and Adaptation::Icap::ModXact::prepPartialBodyEchoing().

◆ 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(), 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(), 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::Icap::Xaction::start ( )
protectedvirtual

Reimplemented from AsyncJob.

Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Definition at line 143 of file Xaction.cc.

References AsyncJob::start().

Referenced by Adaptation::Icap::OptXact::start(), and Adaptation::Icap::ModXact::start().

◆ status()

const char * Adaptation::Icap::Xaction::status ( ) const
protectedvirtual

for debugging, starts with space

Reimplemented from Adaptation::Initiate.

Definition at line 663 of file Xaction.cc.

References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), fillDoneStatus(), fillPendingStatus(), MemBuf::reset(), and MemBuf::terminate().

Referenced by Adaptation::Icap::ModXact::bypassFailure(), callEnd(), Adaptation::Icap::ModXact::callException(), Adaptation::Icap::ModXact::checkConsuming(), closeConnection(), Adaptation::Icap::ModXact::decideWritingAfterPreview(), detailError(), disableRepeats(), disableRetries(), Adaptation::Icap::ModXact::echoMore(), Adaptation::Icap::OptXact::handleCommConnected(), Adaptation::Icap::ModXact::handleCommConnected(), handleCommTimedout(), Adaptation::Icap::OptXact::handleCommWrote(), Adaptation::Icap::ModXact::ModXact(), Adaptation::Icap::ModXact::parseMore(), Adaptation::Icap::OptXact::parseResponse(), Adaptation::Icap::ModXact::stopBackup(), Adaptation::Icap::ModXact::stopParsing(), Adaptation::Icap::ModXact::stopSending(), Adaptation::Icap::ModXact::stopWriting(), Adaptation::Icap::ModXact::swanSong(), Adaptation::Icap::ModXact::waitForService(), Adaptation::Icap::ModXact::writeMore(), and Adaptation::Icap::ModXact::writePreviewBody().

◆ swanSong()

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

Reimplemented from Adaptation::Initiate.

Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.

Definition at line 598 of file Xaction.cc.

References CallJobHere, SBuf::clear(), closeConnection(), cs, debugs, HERE(), maybeLog(), Adaptation::Icap::ServiceRep::noteConnectionFailed(), NULL, readBuf, service(), Adaptation::Initiate::swanSong(), tellQueryAborted(), and CbcPointer< Cbc >::valid().

Referenced by detailError(), Adaptation::Icap::OptXact::swanSong(), and Adaptation::Icap::ModXact::swanSong().

◆ tellQueryAborted() [1/2]

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 Adaptation::Ecap::XactionRep::adaptationAborted(), Adaptation::Iterator::handleAdaptationError(), Adaptation::Icap::Launcher::noteXactAbort(), Adaptation::Initiate::swanSong(), Adaptation::Iterator::swanSong(), and Adaptation::Icap::Launcher::swanSong().

◆ tellQueryAborted() [2/2]

void Adaptation::Icap::Xaction::tellQueryAborted ( )
private

Definition at line 619 of file Xaction.cc.

References CallJobHere1, Adaptation::Initiate::clearInitiator(), CbcPointer< Cbc >::get(), RefCount< C >::getRaw(), icapReply, icapRequest, repeatable(), retriable(), CbcPointer< Cbc >::set(), and Adaptation::Initiate::theInitiator.

Referenced by clearError(), and swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

◆ updateTimeout()

void Adaptation::Icap::Xaction::updateTimeout ( )
protected

Definition at line 422 of file Xaction.cc.

References commSetConnTimeout(), commUnsetConnTimeout(), connection, haveConnection(), Adaptation::Icap::Config::io_timeout(), JobCallback, Must, noteCommTimedout(), NULL, reader, service(), Adaptation::Icap::TheConfig, and writer.

Referenced by detailError(), noteCommRead(), noteCommWrote(), scheduleRead(), and scheduleWrite().

Member Data Documentation

◆ al

AccessLogEntry& Adaptation::Icap::Xaction::al
protected

Definition at line 149 of file Xaction.h.

Referenced by closeConnection(), Adaptation::Icap::OptXact::finalizeLogInfo(), finalizeLogInfo(), Adaptation::Icap::ModXact::finalizeLogInfo(), noteCommRead(), noteCommWrote(), and setOutcome().

◆ alep

AccessLogEntry::Pointer Adaptation::Icap::Xaction::alep
protected

Definition at line 148 of file Xaction.h.

Referenced by Adaptation::Icap::ModXact::finalizeLogInfo(), and maybeLog().

◆ attempts

int Adaptation::Icap::Xaction::attempts

Definition at line 61 of file Xaction.h.

Referenced by Adaptation::Icap::Launcher::launchXaction(), and Adaptation::Icap::ModXact::start().

◆ closer

AsyncCall::Pointer Adaptation::Icap::Xaction::closer
protected

Definition at line 146 of file Xaction.h.

Referenced by closeConnection(), handleSecuredPeer(), noteCommClosed(), and noteCommConnected().

◆ commEof

bool Adaptation::Icap::Xaction::commEof
protected

Definition at line 134 of file Xaction.h.

Referenced by Adaptation::Icap::OptXact::doneReading(), doneReading(), fillDoneStatus(), noteCommRead(), parseHttpMsg(), and Adaptation::Icap::ModXact::parsePart().

◆ connection

Comm::ConnectionPointer Adaptation::Icap::Xaction::connection
protected

Definition at line 130 of file Xaction.h.

Referenced by cancelRead(), closeConnection(), dnsLookupDone(), fillDoneStatus(), fillPendingStatus(), haveConnection(), noteCommConnected(), openConnection(), scheduleRead(), scheduleWrite(), and updateTimeout().

◆ connector

AsyncCall::Pointer Adaptation::Icap::Xaction::connector
protected

Definition at line 143 of file Xaction.h.

Referenced by closeConnection(), dnsLookupDone(), doneAll(), doneWithIo(), handleCommTimedout(), noteCommConnected(), and openConnection().

◆ cs

Comm::ConnOpener::Pointer Adaptation::Icap::Xaction::cs
private

Definition at line 156 of file Xaction.h.

Referenced by dnsLookupDone(), noteCommConnected(), and swanSong().

◆ icap_tio_finish

timeval Adaptation::Icap::Xaction::icap_tio_finish
protected

Definition at line 153 of file Xaction.h.

Referenced by finalizeLogInfo(), Adaptation::Icap::OptXact::handleCommRead(), Adaptation::Icap::ModXact::handleCommRead(), and Xaction().

◆ icap_tio_start

timeval Adaptation::Icap::Xaction::icap_tio_start
protected

Definition at line 152 of file Xaction.h.

Referenced by finalizeLogInfo(), Adaptation::Icap::OptXact::handleCommConnected(), Adaptation::Icap::ModXact::handleCommConnected(), and Xaction().

◆ icap_tr_start

timeval Adaptation::Icap::Xaction::icap_tr_start
protected

Definition at line 151 of file Xaction.h.

Referenced by finalizeLogInfo(), Adaptation::Icap::ModXact::start(), and Xaction().

◆ icapReply

HttpReply::Pointer Adaptation::Icap::Xaction::icapReply

Definition at line 58 of file Xaction.h.

Referenced by Adaptation::Icap::ModXact::expectIcapTrailers(), Adaptation::Icap::OptXact::finalizeLogInfo(), finalizeLogInfo(), Adaptation::Icap::ModXact::gotEncapsulated(), Adaptation::Icap::ModXact::handle100Continue(), Adaptation::Icap::OptXact::handleCommRead(), Adaptation::Icap::ModXact::ModXact(), Adaptation::Icap::ModXact::parseIcapHead(), Adaptation::Icap::OptXact::parseResponse(), and tellQueryAborted().

◆ icapRequest

HttpRequest* Adaptation::Icap::Xaction::icapRequest

Definition at line 57 of file Xaction.h.

Referenced by finalizeLogInfo(), Adaptation::Icap::OptXact::makeRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), tellQueryAborted(), Xaction(), and ~Xaction().

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ ignoreLastWrite

bool Adaptation::Icap::Xaction::ignoreLastWrite
protected

Definition at line 138 of file Xaction.h.

Referenced by noteCommWrote(), and Adaptation::Icap::ModXact::stopWriting().

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

◆ isRepeatable

bool Adaptation::Icap::Xaction::isRepeatable
protected

Definition at line 137 of file Xaction.h.

Referenced by disableRepeats(), repeatable(), and Adaptation::Icap::ModXact::virginConsume().

◆ isRetriable

bool Adaptation::Icap::Xaction::isRetriable
protected

Definition at line 136 of file Xaction.h.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), Adaptation::Icap::ModXact::callException(), Adaptation::Icap::ModXact::decideOnRetries(), disableRetries(), openConnection(), retriable(), and Adaptation::Icap::ModXact::virginConsume().

◆ readBuf

SBuf Adaptation::Icap::Xaction::readBuf
protected

Definition at line 133 of file Xaction.h.

Referenced by mayReadMore(), noteCommRead(), Adaptation::Icap::ModXact::parseBody(), parseHttpMsg(), Adaptation::Icap::ModXact::parseMore(), Adaptation::Icap::ModXact::parsePart(), Adaptation::Icap::OptXact::parseResponse(), Adaptation::Icap::ModXact::readMore(), scheduleRead(), Adaptation::Icap::ModXact::stopParsing(), and swanSong().

◆ reader

AsyncCall::Pointer Adaptation::Icap::Xaction::reader
protected

Definition at line 144 of file Xaction.h.

Referenced by cancelRead(), closeConnection(), doneAll(), doneWithIo(), fillPendingStatus(), noteCommRead(), Adaptation::Icap::ModXact::readMore(), scheduleRead(), Adaptation::Icap::ModXact::startReading(), and updateTimeout().

◆ reuseConnection

bool Adaptation::Icap::Xaction::reuseConnection
protected

Definition at line 135 of file Xaction.h.

Referenced by Adaptation::Icap::ModXact::bypassFailure(), closeConnection(), handleCommTimedout(), noteCommRead(), Adaptation::Icap::ModXact::parseIcapHead(), Adaptation::Icap::OptXact::parseResponse(), and Adaptation::Icap::ModXact::stopWriting().

◆ securer

AsyncCall::Pointer Adaptation::Icap::Xaction::securer
private

Definition at line 157 of file Xaction.h.

Referenced by doneAll(), handleSecuredPeer(), noteCommClosed(), and noteCommConnected().

◆ stopReason

const char* Adaptation::Icap::Xaction::stopReason
protected

Definition at line 140 of file Xaction.h.

Referenced by fillDoneStatus().

◆ 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(), noteInitiatorAborted(), Adaptation::Initiate::sendAnswer(), Adaptation::Icap::Launcher::start(), Adaptation::Initiate::swanSong(), Adaptation::Iterator::swanSong(), Adaptation::Icap::Launcher::swanSong(), Adaptation::Icap::ModXact::swanSong(), and tellQueryAborted().

◆ theService

Adaptation::Icap::ServiceRep::Pointer Adaptation::Icap::Xaction::theService
protected

Definition at line 131 of file Xaction.h.

Referenced by handleCommTimedout(), noteCommConnected(), and service().

◆ typeName

const char* AsyncJob::typeName
protectedinherited

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), dieOnConnectionFailure(), disableRepeats(), disableRetries(), handleCommTimedout(), handleSecuredPeer(), AsyncJob::mustStop(), openConnection(), Xaction(), AsyncJob::~AsyncJob(), and ~Xaction().

◆ writer

AsyncCall::Pointer Adaptation::Icap::Xaction::writer
protected

Definition at line 145 of file Xaction.h.

Referenced by closeConnection(), doneAll(), doneWithIo(), doneWriting(), fillPendingStatus(), noteCommWrote(), scheduleWrite(), Adaptation::Icap::ModXact::stopWriting(), updateTimeout(), Adaptation::Icap::ModXact::writeMore(), and Adaptation::Icap::ModXact::writeSomeBody().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors