Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
Mgr::Inquirer Class Referenceabstract

#include <Inquirer.h>

Inheritance diagram for Mgr::Inquirer:
Inheritance graph
[legend]
Collaboration diagram for Mgr::Inquirer:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

Public Member Functions

 Inquirer (Action::Pointer anAction, const Request &aCause, const Ipc::StrandCoords &coords)
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static void HandleRemoteAck (const Response &response)
 finds and calls the right Inquirer upon strand's response More...
 
static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Types

typedef std::map< unsigned int, AsyncCall::Pointer > RequestsMap
 maps request->id to Inquirer::handleRemoteAck callback More...
 

Protected Member Functions

virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
virtual void cleanup ()
 closes our copy of the client HTTP connection socket More...
 
virtual void sendResponse ()
 send response to client More...
 
virtual bool aggregate (Ipc::Response::Pointer aResponse)
 perform aggregating of responses and returns true if need to continue More...
 
virtual void swanSong ()
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 
virtual void inquire ()
 inquire the next strand More...
 
virtual void handleException (const std::exception &e)
 do specific exception handling More...
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 

Protected Attributes

Request::Pointer request
 cache manager request received from client More...
 
Ipc::StrandCoords strands
 all strands we want to query, in order More...
 
Ipc::StrandCoords::const_iterator pos
 strand we should query now More...
 
const double timeout
 number of seconds to wait for strand response More...
 
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...
 

Static Protected Attributes

static RequestsMap TheRequestsMap
 pending strand requests More...
 
static unsigned int LastRequestId = 0
 last requestId used More...
 

Private Member Functions

 CBDATA_CLASS (Inquirer)
 
void noteWroteHeader (const CommIoCbParams &params)
 called when we wrote the response header More...
 
void noteCommClosed (const CommCloseCbParams &params)
 called when the HTTP client or some external force closed our socket More...
 
void removeCloseHandler ()
 
Ipc::StrandCoords applyQueryParams (const Ipc::StrandCoords &aStrands, const QueryParams &aParams)
 

Private Attributes

Action::Pointer aggrAction
 
Comm::ConnectionPointer conn
 HTTP client socket descriptor. More...
 
AsyncCall::Pointer writer
 comm_write callback More...
 
AsyncCall::Pointer closer
 comm_close handler More...
 

Detailed Description

Coordinator's job that sends a cache manage request to each strand, aggregating individual strand responses and dumping the result if needed

Definition at line 26 of file Inquirer.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

◆ RequestsMap

typedef std::map<unsigned int, AsyncCall::Pointer> Ipc::Inquirer::RequestsMap
protectedinherited

Definition at line 79 of file Inquirer.h.

Constructor & Destructor Documentation

◆ Inquirer()

Mgr::Inquirer::Inquirer ( Action::Pointer  anAction,
const Request &  aCause,
const Ipc::StrandCoords &  coords 
)

Definition at line 34 of file Inquirer.cc.

References aggrAction, asyncCall(), closer, comm_add_close_handler(), Mgr::Request::conn, conn, debugs, Comm::Connection::fd, Ipc::fdnHttpSocket, HERE(), Ipc::ImportFdIntoComm(), and noteCommClosed().

Member Function Documentation

◆ aggregate()

bool Mgr::Inquirer::aggregate ( Ipc::Response::Pointer  aResponse)
protectedvirtual

Implements Ipc::Inquirer.

Definition at line 119 of file Inquirer.cc.

References aggrAction, Mgr::Response::getAction(), and Mgr::Response::hasAction().

◆ applyQueryParams()

Ipc::StrandCoords Mgr::Inquirer::applyQueryParams ( const Ipc::StrandCoords &  aStrands,
const QueryParams &  aParams 
)
private

Definition at line 144 of file Inquirer.cc.

References debugs, Mgr::QueryParams::get(), RefCount< C >::getRaw(), HERE(), i, int, NULL, Mgr::QueryParam::ptInt, sc, Mgr::QueryParam::type, and Mgr::IntParam::value().

◆ 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 Ipc::Inquirer::callException ( const std::exception &  e)
virtualinherited

Reimplemented from AsyncJob.

Definition at line 128 of file Inquirer.cc.

References AsyncJob::callException(), DBG_CRITICAL, debugs, Ipc::Inquirer::handleException(), and HERE().

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

◆ CBDATA_CLASS()

Mgr::Inquirer::CBDATA_CLASS ( Inquirer  )
private

◆ cleanup()

void Mgr::Inquirer::cleanup ( )
protectedvirtual

Reimplemented from Ipc::Inquirer.

Definition at line 51 of file Inquirer.cc.

References Comm::Connection::close(), conn, Comm::IsConnOpen(), and removeCloseHandler().

◆ 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 Mgr::Inquirer::doneAll ( ) const
protectedvirtual

Reimplemented from Ipc::Inquirer.

Definition at line 138 of file Inquirer.cc.

References Ipc::Inquirer::doneAll(), and writer.

◆ handleException()

void Ipc::Inquirer::handleException ( const std::exception &  e)
protectedvirtualinherited

Reimplemented in Snmp::Inquirer.

Definition at line 121 of file Inquirer.cc.

References debugs, HERE(), and AsyncJob::mustStop().

Referenced by Ipc::Inquirer::callException(), and Snmp::Inquirer::handleException().

◆ HandleRemoteAck()

void Ipc::Inquirer::HandleRemoteAck ( const Response &  response)
staticinherited

Definition at line 156 of file Inquirer.cc.

References UnaryMemFunT< Job, Data, Argument1 >::arg1, Ipc::Response::clone(), Ipc::Inquirer::DequeueRequest(), AsyncCall::getDialer(), Must, NULL, Ipc::Response::requestId, and ScheduleCallHere.

Referenced by Ipc::Coordinator::handleCacheMgrResponse(), and Ipc::Coordinator::handleSnmpResponse().

◆ inquire()

void Ipc::Inquirer::inquire ( )
protectedvirtualinherited

Definition at line 62 of file Inquirer.cc.

References asyncCall(), callback, debugs, AsyncJob::done(), eventAdd(), Ipc::Inquirer::handleRemoteAck(), HERE(), Ipc::Inquirer::LastRequestId, Ipc::Port::MakeAddr(), Must, NULL, Ipc::Inquirer::pos, Ipc::Inquirer::request, Ipc::Inquirer::RequestTimedOut(), Ipc::SendMessage(), Ipc::Inquirer::status(), Ipc::strandAddrLabel, Ipc::Inquirer::strands, Ipc::Inquirer::TheRequestsMap, and Ipc::Inquirer::timeout.

Referenced by Ipc::Inquirer::handleRemoteAck(), noteWroteHeader(), Ipc::Inquirer::requestTimedOut(), and Snmp::Inquirer::start().

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

◆ noteCommClosed()

void Mgr::Inquirer::noteCommClosed ( const CommCloseCbParams &  params)
private

Definition at line 110 of file Inquirer.cc.

References conn, CommCommonCbParams::conn, debugs, RefCount< C >::getRaw(), HERE(), Comm::IsConnOpen(), Must, AsyncJob::mustStop(), and NULL.

Referenced by Inquirer().

◆ noteWroteHeader()

void Mgr::Inquirer::noteWroteHeader ( const CommIoCbParams &  params)
private

Definition at line 97 of file Inquirer.cc.

References conn, CommCommonCbParams::conn, debugs, CommCommonCbParams::flag, RefCount< C >::getRaw(), HERE(), Ipc::Inquirer::inquire(), Must, NULL, Comm::OK, CommIoCbParams::size, and writer.

Referenced by start().

◆ removeCloseHandler()

void Mgr::Inquirer::removeCloseHandler ( )
private

Definition at line 60 of file Inquirer.cc.

References closer, comm_remove_close_handler(), conn, Comm::Connection::fd, and NULL.

Referenced by cleanup(), and sendResponse().

◆ sendResponse()

void Mgr::Inquirer::sendResponse ( )
protectedvirtual

Implements Ipc::Inquirer.

Definition at line 128 of file Inquirer.cc.

References aggrAction, conn, NULL, removeCloseHandler(), AsyncJob::Start(), and Ipc::Inquirer::strands.

◆ start()

void Mgr::Inquirer::start ( )
protectedvirtual

Reimplemented from Ipc::Inquirer.

Definition at line 69 of file Inquirer.cc.

References aggrAction, asyncCall(), ErrorState::BuildHttpReply(), conn, Http::CONNECTION, debugs, ERR_INVALID_URL, HttpRequest::FromUrl(), Http::Message::header, HERE(), XactionInitiator::initIpc, Comm::IsConnOpen(), Must, noteWroteHeader(), NULL, HttpReply::pack(), HttpHeader::putStr(), Http::scNotFound, Http::scOkay, HttpReply::setHeaders(), squid_curtime, Ipc::Inquirer::start(), Ipc::Inquirer::strands, Comm::Write(), and writer.

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

◆ status()

const char * Ipc::Inquirer::status ( ) const
protectedvirtualinherited

for debugging, starts with space

Reimplemented from AsyncJob.

Definition at line 202 of file Inquirer.cc.

References Packable::appendf(), buf, MemBuf::content(), Ipc::Inquirer::request, MemBuf::reset(), and MemBuf::terminate().

Referenced by Ipc::Inquirer::handleRemoteAck(), and Ipc::Inquirer::inquire().

◆ swanSong()

void Ipc::Inquirer::swanSong ( )
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 102 of file Inquirer.cc.

References Ipc::Inquirer::cleanup(), debugs, Ipc::Inquirer::DequeueRequest(), HERE(), Ipc::Inquirer::removeTimeoutEvent(), Ipc::Inquirer::request, and Ipc::Inquirer::sendResponse().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

Member Data Documentation

◆ aggrAction

Action::Pointer Mgr::Inquirer::aggrAction
private

Definition at line 51 of file Inquirer.h.

Referenced by aggregate(), Inquirer(), sendResponse(), and start().

◆ closer

AsyncCall::Pointer Mgr::Inquirer::closer
private

Definition at line 56 of file Inquirer.h.

Referenced by Inquirer(), and removeCloseHandler().

◆ conn

Comm::ConnectionPointer Mgr::Inquirer::conn
private

Definition at line 53 of file Inquirer.h.

Referenced by cleanup(), Inquirer(), noteCommClosed(), noteWroteHeader(), removeCloseHandler(), sendResponse(), and start().

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

◆ LastRequestId

unsigned int Ipc::Inquirer::LastRequestId = 0
staticprotectedinherited

Definition at line 82 of file Inquirer.h.

Referenced by Ipc::Inquirer::inquire().

◆ pos

Ipc::StrandCoords::const_iterator Ipc::Inquirer::pos
protectedinherited

Definition at line 74 of file Inquirer.h.

Referenced by Ipc::Inquirer::doneAll(), Ipc::Inquirer::handleRemoteAck(), Ipc::Inquirer::inquire(), and Ipc::Inquirer::requestTimedOut().

◆ request

Request::Pointer Ipc::Inquirer::request
protectedinherited

Definition at line 71 of file Inquirer.h.

Referenced by Ipc::Inquirer::DequeueRequest(), Ipc::Inquirer::handleRemoteAck(), Ipc::Inquirer::inquire(), Snmp::Inquirer::Inquirer(), Ipc::Inquirer::requestTimedOut(), Ipc::Inquirer::start(), Ipc::Inquirer::status(), and Ipc::Inquirer::swanSong().

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

◆ strands

Ipc::StrandCoords Ipc::Inquirer::strands
protectedinherited

Definition at line 73 of file Inquirer.h.

Referenced by Ipc::Inquirer::doneAll(), Ipc::Inquirer::inquire(), Ipc::Inquirer::Inquirer(), sendResponse(), and start().

◆ TheRequestsMap

Ipc::Inquirer::RequestsMap Ipc::Inquirer::TheRequestsMap
staticprotectedinherited

Definition at line 80 of file Inquirer.h.

Referenced by Ipc::Inquirer::DequeueRequest(), and Ipc::Inquirer::inquire().

◆ timeout

const double Ipc::Inquirer::timeout
protectedinherited

Definition at line 76 of file Inquirer.h.

Referenced by Ipc::Inquirer::inquire().

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

◆ writer

AsyncCall::Pointer Mgr::Inquirer::writer
private

Definition at line 55 of file Inquirer.h.

Referenced by doneAll(), noteWroteHeader(), and start().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors