#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... | |
| 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 (RequestId) |
| finds and calls the right Forwarder upon Coordinator'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 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... | |
| bool | started_ = false |
| Start() has finished successfully. More... | |
| bool | swanSang_ = false |
| swanSong() was called More... | |
Static Protected Attributes | |
| static RequestsMap | TheRequestsMap |
| pending Coordinator requests More... | |
| static RequestId::Index | 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 (RequestId::Index) |
| 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 29 of file Forwarder.h.
Member Typedef Documentation
◆ Pointer
|
inherited |
Definition at line 34 of file AsyncJob.h.
◆ RequestsMap
|
protected |
Definition at line 69 of file Forwarder.h.
Constructor & Destructor Documentation
◆ Forwarder()
| Ipc::Forwarder::Forwarder | ( | Request::Pointer | aRequest, |
| double | aTimeout | ||
| ) |
Definition at line 27 of file Forwarder.cc.
◆ ~Forwarder()
|
virtual |
Reimplemented in Mgr::Forwarder.
Definition at line 34 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 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()
|
virtual |
Reimplemented from AsyncJob.
Definition at line 141 of file Forwarder.cc.
References AsyncJob::callException(), DBG_CRITICAL, debugs, and HERE().
◆ callStart()
|
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()
|
inherited |
Definition at line 102 of file AsyncJob.cc.
References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.
◆ CBDATA_CLASS()
|
private |
◆ deleteThis()
|
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()
|
staticprivate |
◆ done()
|
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()
|
protectedvirtual |
◆ handleError()
|
protectedvirtual |
Reimplemented in Mgr::Forwarder.
Definition at line 121 of file Forwarder.cc.
◆ handleException()
|
protectedvirtual |
Reimplemented in Snmp::Forwarder, and Mgr::Forwarder.
Definition at line 134 of file Forwarder.cc.
References debugs, and HERE().
Referenced by Mgr::Forwarder::handleException(), and Snmp::Forwarder::handleException().
◆ handleRemoteAck()
|
private |
◆ HandleRemoteAck()
|
static |
Definition at line 176 of file Forwarder.cc.
References debugs, HERE(), Must, NULL, and ScheduleCallHere.
Referenced by Ipc::Strand::handleCacheMgrResponse(), and Ipc::Strand::handleSnmpResponse().
◆ handleStopRequest()
|
inlineinherited |
Definition at line 71 of file AsyncJob.h.
References AsyncJob::mustStop().
◆ handleTimeout()
|
protectedvirtual |
Reimplemented in Snmp::Forwarder, and Mgr::Forwarder.
Definition at line 127 of file Forwarder.cc.
Referenced by Mgr::Forwarder::handleTimeout(), and Snmp::Forwarder::handleTimeout().
◆ mustStop()
|
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().
◆ removeTimeoutEvent()
|
private |
Definition at line 169 of file Forwarder.cc.
References eventDelete(), eventFind(), and RequestTimedOut().
◆ requestTimedOut()
|
private |
Definition at line 114 of file Forwarder.cc.
◆ RequestTimedOut()
|
staticprivate |
Definition at line 100 of file Forwarder.cc.
References CallBack(), codeContext, debugs, HERE(), Must, and NULL.
Referenced by removeTimeoutEvent(), and start().
◆ start()
|
protectedvirtual |
Reimplemented from AsyncJob.
Definition at line 42 of file Forwarder.cc.
References Ipc::Port::CoordinatorAddr(), debugs, eventAdd(), handleRemoteAck(), HERE(), JobCallback, request(), RequestTimedOut(), and Ipc::SendMessage().
◆ Start()
|
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(), Mgr::Inquirer::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()
|
protectedvirtualinherited |
for debugging, starts with space
Reimplemented in HappyConnOpener, Security::PeerConnector, Ipc::Inquirer, Comm::TcpAcceptor, Http::Tunneler, Adaptation::Initiate, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, and Adaptation::Ecap::XactionRep.
Definition at line 167 of file AsyncJob.cc.
References MemBuf::append(), Packable::appendf(), MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().
Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Adaptation::Initiate::status(), and Comm::TcpAcceptor::status().
◆ swanSong()
|
protectedvirtual |
Reimplemented from AsyncJob.
Reimplemented in Snmp::Forwarder, and Mgr::Forwarder.
Definition at line 69 of file Forwarder.cc.
References debugs, HERE(), and request().
Referenced by Mgr::Forwarder::swanSong(), and Snmp::Forwarder::swanSong().
◆ toCbdata()
|
pure virtualinherited |
Implemented in HttpStateData, ClientHttpRequest, and BodySink.
Referenced by AsyncJob::callException(), and AsyncJob::callStart().
Member Data Documentation
◆ codeContext
| CodeContextPointer Ipc::Forwarder::codeContext |
Definition at line 43 of file Forwarder.h.
Referenced by RequestTimedOut().
◆ id
|
inherited |
Definition at line 73 of file AsyncJob.h.
◆ inCall
|
protectedinherited |
Definition at line 81 of file AsyncJob.h.
Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().
◆ LastRequestId
|
staticprotected |
Definition at line 72 of file Forwarder.h.
◆ request
|
protected |
Definition at line 65 of file Forwarder.h.
◆ started_
|
protectedinherited |
Definition at line 83 of file AsyncJob.h.
Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().
◆ stopReason
|
protectedinherited |
Definition at line 79 of file AsyncJob.h.
Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().
◆ swanSang_
|
protectedinherited |
Definition at line 84 of file AsyncJob.h.
Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().
◆ TheRequestsMap
|
staticprotected |
Definition at line 70 of file Forwarder.h.
◆ timeout
|
protected |
Definition at line 66 of file Forwarder.h.
◆ 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().
The documentation for this class was generated from the following files:
- src/ipc/Forwarder.h
- src/ipc/Forwarder.cc