#include <Xaction.h>
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
Member Typedef Documentation
|
inherited |
Definition at line 34 of file AsyncJob.h.
Constructor & Destructor Documentation
| 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.
|
virtual |
Definition at line 108 of file Xaction.cc.
References debugs, and HTTPMSGUNLOCK().
Member Function Documentation
|
virtual |
called right after the called job method
Reimplemented from AsyncJob.
Definition at line 408 of file Xaction.cc.
References AsyncJob::callEnd(), debugs, and HERE().
|
virtual |
Reimplemented from AsyncJob.
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 401 of file Xaction.cc.
References AsyncJob::callException(), and Adaptation::Icap::xoError.
Referenced by Adaptation::Icap::ModXact::callException().
|
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.
|
inherited |
Definition at line 101 of file AsyncJob.cc.
References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.
|
protected |
Definition at line 513 of file Xaction.cc.
References Must, NULL, and Comm::ReadCancel().
|
inlinevirtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 113 of file Xaction.h.
Referenced by Adaptation::Icap::Launcher::launchXaction().
|
protectedinherited |
Definition at line 74 of file Initiate.cc.
|
protected |
Definition at line 244 of file Xaction.cc.
References comm_remove_close_handler(), debugs, HERE(), NULL, Adaptation::Icap::xoError, and Adaptation::Icap::xoGone.
|
protectedinherited |
Definition at line 49 of file AsyncJob.cc.
References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.
Referenced by ConnStateData::connStateClosed().
|
inlineprotectedvirtual |
Reimplemented in Adaptation::Icap::ModXact.
|
protected |
Definition at line 322 of file Xaction.cc.
References debugs, ERR_DETAIL_ICAP_XACT_START, HERE(), and TexcHere.
| void Adaptation::Icap::Xaction::disableRepeats | ( | const char * | reason | ) |
Definition at line 136 of file Xaction.cc.
References debugs.
Referenced by Adaptation::Icap::Launcher::launchXaction().
| void Adaptation::Icap::Xaction::disableRetries | ( | ) |
Definition at line 129 of file Xaction.cc.
References debugs.
Referenced by Adaptation::Icap::Launcher::launchXaction().
| 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(), Dns::CachedIps::current(), DBG_IMPORTANT, debugs, getOutgoingAddress(), Adaptation::ServiceConfig::host, JobCallback, noteCommConnected(), NULL, Adaptation::ServiceConfig::port, Ip::Address::port(), Comm::Connection::remote, ScheduleCallHere, Comm::ConnOpener::setHost(), AsyncJob::Start(), String::termedBuf(), and Adaptation::Icap::TheConfig.
Referenced by icapLookupDnsResults().
|
protectedinherited |
Definition at line 90 of file AsyncJob.cc.
References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.
Referenced by AsyncJob::callEnd(), and Downloader::downloadFinished().
|
protectedvirtual |
Reimplemented from AsyncJob.
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 417 of file Xaction.cc.
References AsyncJob::doneAll().
Referenced by Adaptation::Icap::ModXact::doneAll().
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
Definition at line 549 of file Xaction.cc.
|
protected |
Definition at line 559 of file Xaction.cc.
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 554 of file Xaction.cc.
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 692 of file Xaction.cc.
References MemBuf::append(), Packable::appendf(), and NULL.
Referenced by Adaptation::Icap::ModXact::fillDoneStatus().
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 677 of file Xaction.cc.
References MemBuf::append(), Packable::appendf(), and NULL.
Referenced by Adaptation::Icap::ModXact::fillPendingStatus().
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 701 of file Xaction.cc.
|
protectedvirtual |
Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
Definition at line 640 of file Xaction.cc.
References Adaptation::Service::cfg(), current_time, Adaptation::ServiceConfig::host, HTTPMSGLOCK(), ICP_INVALID, Adaptation::ServiceConfig::key, NULL, String::termedBuf(), tvSub(), and Adaptation::ServiceConfig::uri.
Referenced by Adaptation::Icap::OptXact::finalizeLogInfo(), and Adaptation::Icap::ModXact::finalizeLogInfo().
|
protectedvirtual |
Definition at line 395 of file Xaction.cc.
References ERR_DETAIL_ICAP_XACT_CLOSE.
|
protectedpure virtual |
Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
|
protectedpure virtual |
Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
|
protectedvirtual |
|
protectedpure virtual |
Implemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
|
protected |
Definition at line 738 of file Xaction.cc.
References Comm::Connection::close(), comm_remove_close_handler(), Security::EncryptorAnswer::conn, debugs, ERR_DETAIL_ICAP_XACT_SSL_START, Security::EncryptorAnswer::error, Comm::Connection::fd, CbcPointer< Cbc >::get(), Must, NULL, and TexcHere.
Referenced by noteCommConnected().
|
protected |
Definition at line 566 of file Xaction.cc.
References NULL.
|
inherited |
Definition at line 54 of file Initiate.cc.
References i, Must, and CbcPointer< Cbc >::valid().
Referenced by Adaptation::Initiator::initiateAdaptation().
|
virtual |
Reimplemented in Adaptation::Icap::ModXact.
Definition at line 116 of file Xaction.cc.
|
private |
Definition at line 632 of file Xaction.cc.
References IcapLogfileStatus, icapLogLog(), and LOG_ENABLE.
|
protected |
Definition at line 543 of file Xaction.cc.
|
protectedinherited |
Definition at line 69 of file AsyncJob.cc.
References debugs, AsyncJob::inCall, Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.
Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().
| void Adaptation::Icap::Xaction::noteCommClosed | ( | const CommCloseCbParams & | io | ) |
| void Adaptation::Icap::Xaction::noteCommConnected | ( | const CommConnectCbParams & | io | ) |
Definition at line 278 of file Xaction.cc.
References asyncCall(), comm_add_close_handler(), commSetConnTimeout(), CommCommonCbParams::conn, Adaptation::Icap::Config::connect_timeout(), Comm::Connection::fd, fd_table, CommCommonCbParams::flag, handleSecuredPeer(), Must, noteCommClosed(), noteCommTimedout(), NULL, Comm::OK, AsyncJob::Start(), Adaptation::Icap::TheConfig, and Comm::TIMEOUT.
Referenced by dnsLookupDone(), and openConnection().
| void Adaptation::Icap::Xaction::noteCommRead | ( | const CommIoCbParams & | io | ) |
Definition at line 453 of file Xaction.cc.
References CommCommonCbParams::conn, debugs, Comm::ENDFILE, CommCommonCbParams::flag, Comm::INPROGRESS, Must, NULL, Comm::OK, Comm::ReadNow(), CommIoCbParams::size, CommCommonCbParams::xerrno, Adaptation::Icap::xoRace, and xstrerr().
Referenced by scheduleRead().
| void Adaptation::Icap::Xaction::noteCommTimedout | ( | const CommTimeoutCbParams & | io | ) |
Definition at line 362 of file Xaction.cc.
Referenced by noteCommConnected(), and updateTimeout().
| void Adaptation::Icap::Xaction::noteCommWrote | ( | const CommIoCbParams & | io | ) |
Definition at line 344 of file Xaction.cc.
References debugs, CommCommonCbParams::flag, HERE(), Must, NULL, Comm::OK, and CommIoCbParams::size.
Referenced by scheduleWrite().
|
protectedvirtual |
Implements Adaptation::Initiate.
Definition at line 572 of file Xaction.cc.
References debugs, ERR_DETAIL_ICAP_INIT_GONE, HERE(), and Adaptation::Icap::xoGone.
|
protected |
Definition at line 157 of file Xaction.cc.
References asyncCall(), Adaptation::Service::cfg(), debugs, Adaptation::Icap::ServiceRep::getConnection(), Adaptation::ServiceConfig::host, icapLookupDnsResults(), ipcache_nbgethostbyname(), Comm::IsConnOpen(), Must, noteCommConnected(), Comm::OK, Adaptation::ServiceConfig::port, Adaptation::Icap::Config::reuse_connections, ScheduleCallHere, String::termedBuf(), and Adaptation::Icap::TheConfig.
|
protected |
Definition at line 523 of file Xaction.cc.
References buf, debugs, error(), Http::Message::hdr_sz, Must, Http::Message::parse(), Http::Message::reset(), and Http::scNone.
|
inline |
Definition at line 47 of file Xaction.h.
References isRepeatable.
|
inline |
Definition at line 46 of file Xaction.h.
References isRetriable.
|
protected |
Definition at line 440 of file Xaction.cc.
References JobCallback, Must, noteCommRead(), and Comm::Read().
|
protected |
Definition at line 331 of file Xaction.cc.
References JobCallback, Must, noteCommWrote(), and Comm::Write().
|
protectedinherited |
Definition at line 79 of file Initiate.cc.
References Adaptation::Initiator::noteAdaptationAnswer(), and ScheduleCallHere.
| Adaptation::Icap::ServiceRep & Adaptation::Icap::Xaction::service | ( | ) |
Definition at line 123 of file Xaction.cc.
Referenced by Adaptation::Icap::ConnWaiterDialer::ConnWaiterDialer().
|
protected |
Definition at line 585 of file Xaction.cc.
References debugs, HERE(), and Adaptation::Icap::xoUnknown.
|
staticinherited |
Definition at line 23 of file AsyncJob.cc.
References CallJobHere, and AsyncJob::start().
Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), FwdState::connectDone(), FwdState::connectStart(), TunnelStateData::connectToPeer(), dnsLookupDone(), Log::TcpLogger::doConnect(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), noteCommConnected(), Log::TcpLogger::Open(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), 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().
|
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().
|
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(), MemBuf::reset(), and MemBuf::terminate().
Referenced by Adaptation::Icap::ModXact::ModXact().
|
protectedvirtual |
Reimplemented from Adaptation::Initiate.
Reimplemented in Adaptation::Icap::ModXact, and Adaptation::Icap::OptXact.
Definition at line 598 of file Xaction.cc.
References CallJobHere, debugs, HERE(), NULL, and Adaptation::Initiate::swanSong().
Referenced by Adaptation::Icap::OptXact::swanSong(), and Adaptation::Icap::ModXact::swanSong().
|
protectedinherited |
Definition at line 87 of file Initiate.cc.
References Adaptation::Answer::Error().
|
private |
Definition at line 619 of file Xaction.cc.
References CallJobHere1.
|
pure virtualinherited |
Implemented in ClientHttpRequest, HttpStateData, and BodySink.
Referenced by AsyncJob::callException(), and AsyncJob::callStart().
|
protected |
Definition at line 422 of file Xaction.cc.
References commSetConnTimeout(), commUnsetConnTimeout(), Adaptation::Icap::Config::io_timeout(), JobCallback, Must, noteCommTimedout(), NULL, and Adaptation::Icap::TheConfig.
Member Data Documentation
|
protected |
|
protected |
| int Adaptation::Icap::Xaction::attempts |
Definition at line 61 of file Xaction.h.
Referenced by Adaptation::Icap::Launcher::launchXaction().
|
protected |
|
protected |
Definition at line 134 of file Xaction.h.
Referenced by Adaptation::Icap::OptXact::doneReading(), and Adaptation::Icap::ModXact::doneReading().
|
protected |
|
protected |
|
private |
|
protected |
|
protected |
|
protected |
| HttpReply::Pointer Adaptation::Icap::Xaction::icapReply |
Definition at line 58 of file Xaction.h.
Referenced by Adaptation::Icap::ModXact::ModXact().
| HttpRequest* Adaptation::Icap::Xaction::icapRequest |
|
protectedinherited |
Definition at line 72 of file AsyncJob.h.
|
protectedinherited |
Definition at line 71 of file AsyncJob.h.
Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().
|
protected |
Definition at line 137 of file Xaction.h.
Referenced by repeatable().
|
protected |
Definition at line 136 of file Xaction.h.
Referenced by retriable().
|
protected |
|
private |
|
protected |
|
protectedinherited |
Definition at line 51 of file Initiate.h.
|
protected |
|
protectedinherited |
Definition at line 70 of file AsyncJob.h.
Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), AsyncJob::mustStop(), Xaction(), and AsyncJob::~AsyncJob().
|
protected |
The documentation for this class was generated from the following files:
- src/adaptation/icap/Xaction.h
- src/adaptation/icap/Xaction.cc