Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static 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...
 
void handleStopRequest ()
 process external request to terminate now (i.e. during this async call) 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 void Start (const Pointer &job)
 

Public Attributes

CodeContextPointer codeContext
 
const InstanceId< AsyncJob > id
 job identifier More...
 

Protected Types

typedef std::map< RequestId::Index, 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...
 
bool started_ = false
 Start() has finished successfully. More...
 
bool swanSang_ = false
 swanSong() was called More...
 

Static Protected Attributes

static RequestsMap TheRequestsMap
 pending strand requests More...
 
static RequestId::Index LastRequestId = 0
 last requestId used More...
 

Private Types

typedef UnaryMemFunT< Inquirer, Response::Pointer, Response::Pointer > HandleAckDialer
 

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)
 
void handleRemoteAck (Response::Pointer response)
 called when a strand is done writing its output More...
 
void requestTimedOut ()
 called when the strand failed to respond (or finish responding) in time More...
 
void removeTimeoutEvent ()
 called when we are no longer waiting for the strand to respond More...
 

Static Private Member Functions

static AsyncCall::Pointer DequeueRequest (RequestId::Index)
 returns and forgets the right Inquirer callback for strand request More...
 
static void RequestTimedOut (void *param)
 Ipc::Inquirer::requestTimedOut wrapper. More...
 

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

◆ HandleAckDialer

typedef UnaryMemFunT<Inquirer, Response::Pointer, Response::Pointer> Ipc::Inquirer::HandleAckDialer
privateinherited

Definition at line 63 of file Inquirer.h.

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

◆ RequestsMap

typedef std::map<RequestId::Index, AsyncCall::Pointer> Ipc::Inquirer::RequestsMap
protectedinherited

Definition at line 82 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(), conn, Mgr::Request::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 122 of file Inquirer.cc.

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

◆ applyQueryParams()

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

Definition at line 147 of file Inquirer.cc.

References debugs, Mgr::QueryParams::get(), RefCount< C >::getRaw(), HERE(), 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 137 of file AsyncJob.cc.

References assert, AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), HERE(), AsyncJob::inCall, NULL, AsyncJob::started_, AsyncJob::status(), AsyncJob::swanSang_, AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

◆ callException()

void Ipc::Inquirer::callException ( const std::exception &  e)
virtualinherited

Reimplemented from AsyncJob.

Definition at line 129 of file Inquirer.cc.

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall &  call)
inherited

called just before the called method

Definition at line 115 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall &  call) const
inherited

Definition at line 102 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

◆ 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 conn, and Comm::IsConnOpen().

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

Definition at line 50 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed().

◆ DequeueRequest()

AsyncCall::Pointer Ipc::Inquirer::DequeueRequest ( RequestId::Index  requestId)
staticprivateinherited

Definition at line 142 of file Inquirer.cc.

References debugs, HERE(), Must, NULL, and request().

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

Definition at line 91 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), HappyConnOpener::checkForNewConnection(), Downloader::downloadFinished(), and HappyConnOpener::maybeOpenPrimeConnection().

◆ doneAll()

bool Mgr::Inquirer::doneAll ( ) const
protectedvirtual

Reimplemented from Ipc::Inquirer.

Definition at line 141 of file Inquirer.cc.

References Ipc::Inquirer::doneAll().

◆ handleException()

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

Reimplemented in Snmp::Inquirer.

Definition at line 122 of file Inquirer.cc.

References debugs, and HERE().

Referenced by Snmp::Inquirer::handleException().

◆ HandleRemoteAck()

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

Definition at line 157 of file Inquirer.cc.

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

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

◆ handleRemoteAck()

void Ipc::Inquirer::handleRemoteAck ( Response::Pointer  response)
privateinherited

Definition at line 88 of file Inquirer.cc.

References debugs, HERE(), Must, and request().

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

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )
inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ inquire()

void Ipc::Inquirer::inquire ( )
protectedvirtualinherited

Definition at line 63 of file Inquirer.cc.

References asyncCall(), debugs, eventAdd(), Ipc::Inquirer::handleRemoteAck(), HERE(), Ipc::Port::MakeAddr(), Must, NULL, request(), Ipc::Inquirer::RequestTimedOut(), Ipc::SendMessage(), and Ipc::strandAddrLabel.

◆ mustStop()

void AsyncJob::mustStop ( const char *  aReason)
protectedinherited

Definition at line 70 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::drop1xx(), HttpStateData::handleMoreRequestBodyAvailable(), AsyncJob::handleStopRequest(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ noteCommClosed()

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

Definition at line 110 of file Inquirer.cc.

References conn, debugs, and HERE().

Referenced by Inquirer().

◆ noteWroteHeader()

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

Definition at line 97 of file Inquirer.cc.

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

Referenced by start().

◆ removeCloseHandler()

void Mgr::Inquirer::removeCloseHandler ( )
private

Definition at line 60 of file Inquirer.cc.

References comm_remove_close_handler(), conn, and NULL.

◆ removeTimeoutEvent()

void Ipc::Inquirer::removeTimeoutEvent ( )
privateinherited

Definition at line 171 of file Inquirer.cc.

References eventDelete(), eventFind(), and Ipc::Inquirer::RequestTimedOut().

◆ requestTimedOut()

void Ipc::Inquirer::requestTimedOut ( )
privateinherited

Definition at line 192 of file Inquirer.cc.

References debugs, HERE(), Must, and request().

◆ RequestTimedOut()

void Ipc::Inquirer::RequestTimedOut ( void *  param)
staticprivateinherited

Definition at line 179 of file Inquirer.cc.

References CallBack(), Ipc::Inquirer::codeContext, debugs, HERE(), Must, and NULL.

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

◆ sendResponse()

void Mgr::Inquirer::sendResponse ( )
protectedvirtual

Implements Ipc::Inquirer.

Definition at line 131 of file Inquirer.cc.

References conn, NULL, and AsyncJob::Start().

◆ start()

void Mgr::Inquirer::start ( )
protectedvirtual

Reimplemented from Ipc::Inquirer.

Definition at line 69 of file Inquirer.cc.

References asyncCall(), ErrorState::BuildHttpReply(), conn, Http::CONNECTION, debugs, ERR_INVALID_URL, HttpRequest::FromUrlXXX(), 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(), and Comm::Write().

◆ Start()

void AsyncJob::Start ( const Pointer &  job)
staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 24 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), 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 205 of file Inquirer.cc.

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

◆ swanSong()

void Ipc::Inquirer::swanSong ( )
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 103 of file Inquirer.cc.

References debugs, HERE(), and request().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in HttpStateData, ClientHttpRequest, and BodySink.

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

Member Data Documentation

◆ aggrAction

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

Definition at line 51 of file Inquirer.h.

Referenced by Inquirer().

◆ closer

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

Definition at line 56 of file Inquirer.h.

Referenced by Inquirer().

◆ codeContext

CodeContextPointer Ipc::Inquirer::codeContext
inherited

Definition at line 42 of file Inquirer.h.

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

◆ conn

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

Definition at line 53 of file Inquirer.h.

Referenced by Inquirer().

◆ id

const InstanceId<AsyncJob> AsyncJob::id
inherited

Definition at line 73 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

Definition at line 81 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ LastRequestId

Ipc::RequestId::Index Ipc::Inquirer::LastRequestId = 0
staticprotectedinherited

Definition at line 85 of file Inquirer.h.

◆ pos

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

Definition at line 77 of file Inquirer.h.

◆ request

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

Definition at line 74 of file Inquirer.h.

Referenced by Snmp::Inquirer::Inquirer().

◆ started_

bool AsyncJob::started_ = false
protectedinherited

Definition at line 83 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

Definition at line 79 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ strands

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

Definition at line 76 of file Inquirer.h.

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

◆ swanSang_

bool AsyncJob::swanSang_ = false
protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ TheRequestsMap

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

Definition at line 83 of file Inquirer.h.

◆ timeout

const double Ipc::Inquirer::timeout
protectedinherited

Definition at line 79 of file Inquirer.h.

◆ typeName

const char* AsyncJob::typeName
protectedinherited

Definition at line 80 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), Adaptation::Icap::Xaction::Xaction(), AsyncJob::~AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ writer

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

Definition at line 55 of file Inquirer.h.

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors