#include <Forwarder.h>
Public Types | |
| typedef CbcPointer< AsyncJob > | Pointer |
Public Member Functions | |
| Forwarder (Request::Pointer aRequest, double aTimeout) | |
| virtual | ~Forwarder () |
| 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 (unsigned int requestId) |
| finds and calls the right Forwarder upon Coordinator'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 Forwarder::handleRemoteAck callback More... | |
Protected Member Functions | |
| virtual void | start () |
| called by AsyncStart; do not call directly More... | |
| virtual void | swanSong () |
| virtual bool | doneAll () const |
| whether positive goal has been reached More... | |
| virtual void | handleError () |
| virtual void | handleTimeout () |
| virtual void | handleException (const std::exception &e) |
| terminate with an error More... | |
| void | deleteThis (const char *aReason) |
| void | mustStop (const char *aReason) |
| bool | done () const |
| the job is destroyed in callEnd() when done() More... | |
| virtual const char * | status () const |
| internal cleanup; do not call directly More... | |
Protected Attributes | |
| Request::Pointer | request |
| const double | timeout |
| response wait timeout in seconds 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 Coordinator requests More... | |
| static unsigned int | LastRequestId = 0 |
| last requestId used More... | |
Private Member Functions | |
| CBDATA_CLASS (Forwarder) | |
| void | requestTimedOut () |
| called when Coordinator fails to start processing the request [in time] More... | |
| void | removeTimeoutEvent () |
| called when we are no longer waiting for Coordinator to respond More... | |
| void | handleRemoteAck () |
| called when Coordinator starts processing the request More... | |
Static Private Member Functions | |
| static void | RequestTimedOut (void *param) |
| Ipc::Forwarder::requestTimedOut wrapper. More... | |
| static AsyncCall::Pointer | DequeueRequest (unsigned int requestId) |
| returns and forgets the right Forwarder callback for the request More... | |
Detailed Description
Forwards a worker request to coordinator. Waits for an ACK from Coordinator Send the data unit with an error response if forwarding fails.
Definition at line 28 of file Forwarder.h.
Member Typedef Documentation
◆ Pointer
|
inherited |
Definition at line 34 of file AsyncJob.h.
◆ RequestsMap
|
protected |
Definition at line 66 of file Forwarder.h.
Constructor & Destructor Documentation
◆ Forwarder()
| Ipc::Forwarder::Forwarder | ( | Request::Pointer | aRequest, |
| double | aTimeout | ||
| ) |
Definition at line 26 of file Forwarder.cc.
◆ ~Forwarder()
|
virtual |
Reimplemented in Mgr::Forwarder.
Definition at line 32 of file Forwarder.cc.
References Must, request, and SWALLOW_EXCEPTIONS.
Member Function Documentation
◆ 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()
|
virtual |
Reimplemented from AsyncJob.
Definition at line 136 of file Forwarder.cc.
References AsyncJob::callException(), DBG_CRITICAL, debugs, handleException(), and HERE().
◆ callStart()
|
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()
|
inherited |
Definition at line 101 of file AsyncJob.cc.
References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.
Referenced by AsyncJob::swanSong().
◆ CBDATA_CLASS()
|
private |
◆ deleteThis()
|
protectedinherited |
Definition at line 49 of file AsyncJob.cc.
References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.
◆ DequeueRequest()
|
staticprivate |
Definition at line 148 of file Forwarder.cc.
References debugs, HERE(), Must, NULL, request, and TheRequestsMap.
Referenced by HandleRemoteAck(), and swanSong().
◆ done()
|
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()
|
protectedvirtual |
◆ handleError()
|
protectedvirtual |
Reimplemented in Mgr::Forwarder.
Definition at line 116 of file Forwarder.cc.
References AsyncJob::mustStop().
Referenced by start().
◆ handleException()
|
protectedvirtual |
Reimplemented in Mgr::Forwarder, and Snmp::Forwarder.
Definition at line 129 of file Forwarder.cc.
References debugs, HERE(), and AsyncJob::mustStop().
Referenced by callException(), Snmp::Forwarder::handleException(), and Mgr::Forwarder::handleException().
◆ HandleRemoteAck()
|
static |
Definition at line 171 of file Forwarder.cc.
References debugs, DequeueRequest(), HERE(), Must, NULL, and ScheduleCallHere.
Referenced by Ipc::Strand::handleCacheMgrResponse(), and Ipc::Strand::handleSnmpResponse().
◆ handleRemoteAck()
|
private |
◆ handleTimeout()
|
protectedvirtual |
Reimplemented in Mgr::Forwarder, and Snmp::Forwarder.
Definition at line 122 of file Forwarder.cc.
References AsyncJob::mustStop().
Referenced by Snmp::Forwarder::handleTimeout(), Mgr::Forwarder::handleTimeout(), and requestTimedOut().
◆ mustStop()
|
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(), handleError(), handleException(), Ipc::Inquirer::handleException(), HttpStateData::handleMoreRequestBodyAvailable(), Ipc::Inquirer::handleRemoteAck(), handleTimeout(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), Adaptation::Icap::ModXact::noteBodyConsumerAborted(), Snmp::Forwarder::noteCommClosed(), Snmp::Inquirer::noteCommClosed(), Mgr::Inquirer::noteCommClosed(), Mgr::Forwarder::noteCommClosed(), Mgr::StoreToCommWriter::noteCommClosed(), Adaptation::Icap::Xaction::noteCommRead(), Rock::HeaderUpdater::noteDoneReading(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Ecap::XactionRep::noteInitiatorAborted(), HttpStateData::readReply(), Comm::ConnOpener::sendAnswer(), Rock::Rebuild::start(), Security::PeerConnector::start(), HttpStateData::start(), Ipc::UdsSender::timedout(), and HttpStateData::wroteLast().
◆ removeTimeoutEvent()
|
private |
Definition at line 164 of file Forwarder.cc.
References eventDelete(), eventFind(), and RequestTimedOut().
Referenced by swanSong().
◆ RequestTimedOut()
|
staticprivate |
Definition at line 98 of file Forwarder.cc.
References CallJobHere, debugs, HERE(), Must, NULL, and requestTimedOut().
Referenced by removeTimeoutEvent(), and start().
◆ requestTimedOut()
|
private |
Definition at line 109 of file Forwarder.cc.
References debugs, handleTimeout(), and HERE().
Referenced by RequestTimedOut().
◆ Start()
|
staticinherited |
Definition at line 23 of file AsyncJob.cc.
References CallJobHere, and AsyncJob::start().
Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), TunnelStateData::connectedToPeer(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), FwdState::establishTunnelThruProxy(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Adaptation::Initiator::initiateAdaptation(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeerIfNeeded(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().
◆ start()
|
protectedvirtual |
Reimplemented from AsyncJob.
Definition at line 40 of file Forwarder.cc.
References callback, Ipc::Port::CoordinatorAddr(), debugs, eventAdd(), handleError(), handleRemoteAck(), HERE(), JobCallback, LastRequestId, request, RequestTimedOut(), Ipc::SendMessage(), TheRequestsMap, and timeout.
◆ status()
|
protectedvirtualinherited |
for debugging, starts with space
Reimplemented in Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Http::Tunneler, Adaptation::Initiate, Comm::TcpAcceptor, and Ipc::Inquirer.
Definition at line 159 of file AsyncJob.cc.
References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().
Referenced by BodyPipe::buf(), AsyncJob::callEnd(), AsyncJob::callStart(), ClientRequestContext::clientAccessCheckDone(), ClientRequestContext::clientRedirectDone(), Ftp::Client::ctrlClosed(), Ftp::Relay::dataChannelConnected(), Ftp::Client::dataClosed(), Ftp::Client::dataComplete(), Ftp::Client::doneSendingRequestBody(), Ftp::Client::handleControlReply(), Ftp::Client::handleEpsvReply(), Ftp::Client::handlePasvReply(), Ftp::Client::parseControlReply(), Ftp::Relay::processReplyBody(), Ftp::Gateway::processReplyBody(), Ftp::Relay::readTransferDoneReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), Adaptation::Initiate::status(), Comm::TcpAcceptor::status(), and AsyncJob::swanSong().
◆ swanSong()
|
protectedvirtual |
Reimplemented from AsyncJob.
Reimplemented in Mgr::Forwarder, and Snmp::Forwarder.
Definition at line 67 of file Forwarder.cc.
References debugs, DequeueRequest(), HERE(), removeTimeoutEvent(), and request.
Referenced by Snmp::Forwarder::swanSong(), and Mgr::Forwarder::swanSong().
◆ toCbdata()
|
pure virtualinherited |
Implemented in ClientHttpRequest, HttpStateData, and BodySink.
Referenced by AsyncJob::callException(), AsyncJob::callStart(), and CbdataParent::~CbdataParent().
Member Data Documentation
◆ id
|
protectedinherited |
Definition at line 72 of file AsyncJob.h.
◆ 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
|
staticprotected |
Definition at line 69 of file Forwarder.h.
Referenced by start().
◆ request
|
protected |
Definition at line 62 of file Forwarder.h.
Referenced by DequeueRequest(), doneAll(), handleRemoteAck(), start(), swanSong(), and ~Forwarder().
◆ 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().
◆ TheRequestsMap
|
staticprotected |
Definition at line 67 of file Forwarder.h.
Referenced by DequeueRequest(), and start().
◆ timeout
|
protected |
Definition at line 63 of file Forwarder.h.
Referenced by start().
◆ 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().
The documentation for this class was generated from the following files:
- src/ipc/Forwarder.h
- src/ipc/Forwarder.cc