#include <UdsOp.h>
Public Types | |
| typedef CbcPointer< AsyncJob > | Pointer |
Public Member Functions | |
| UdsOp (const String &pathAddr) | |
| virtual | ~UdsOp () |
| 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 | callException (const std::exception &e) |
| called when the job throws during an async call More... | |
| 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 | |
| struct sockaddr_un | address |
| UDS address from path; treat as read-only. More... | |
Protected Member Functions | |
| virtual void | timedout () |
| called after setTimeout() if timed out More... | |
| Comm::ConnectionPointer & | conn () |
| creates if needed and returns raw UDS socket descriptor More... | |
| void | setTimeout (int seconds, const char *handlerName) |
| call timedout() if no UDS messages in a given number of seconds More... | |
| void | clearTimeout () |
| remove previously set timeout, if any More... | |
| void | setOptions (int newOptions) |
| changes socket options More... | |
| void | deleteThis (const char *aReason) |
| void | mustStop (const char *aReason) |
| bool | done () const |
| the job is destroyed in callEnd() when done() More... | |
| virtual void | start () |
| called by AsyncStart; do not call directly More... | |
| 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... | |
Protected Attributes | |
| 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... | |
Private Member Functions | |
| void | noteTimeout (const CommTimeoutCbParams &p) |
| Comm timeout callback; calls timedout() More... | |
| UdsOp (const UdsOp &) | |
| UdsOp & | operator= (const UdsOp &) |
Private Attributes | |
| int | options |
| UDS options. More... | |
| Comm::ConnectionPointer | conn_ |
| UDS descriptor. More... | |
Detailed Description
code shared by unix-domain socket senders (e.g., UdsSender or Coordinator) and receivers (e.g. Port or Coordinator)
Member Typedef Documentation
◆ Pointer
|
inherited |
Definition at line 34 of file AsyncJob.h.
Constructor & Destructor Documentation
◆ UdsOp() [1/2]
| Ipc::UdsOp::UdsOp | ( | const String & | pathAddr | ) |
◆ ~UdsOp()
|
virtual |
Definition at line 27 of file UdsOp.cc.
References Comm::Connection::close(), conn_, debugs, HERE(), Comm::IsConnOpen(), and NULL.
◆ UdsOp() [2/2]
|
private |
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()
|
virtualinherited |
Reimplemented in ClientHttpRequest, Adaptation::Icap::ModXact, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, Ftp::Server, Ipc::Forwarder, and Ipc::Inquirer.
Definition at line 127 of file AsyncJob.cc.
References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().
Referenced by Ipc::Inquirer::callException(), Ipc::Forwarder::callException(), Ftp::Server::callException(), Adaptation::Icap::Xaction::callException(), and AsyncJob::swanSong().
◆ 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().
◆ clearTimeout()
|
protected |
Definition at line 62 of file UdsOp.cc.
References commUnsetConnTimeout(), and conn().
Referenced by Ipc::Strand::handleRegistrationResponse(), and timedout().
◆ conn()
|
protected |
Definition at line 41 of file UdsOp.cc.
References address, COMM_DOBIND, comm_open_uds(), conn_, Comm::Connection::fd, Comm::IsConnOpen(), Must, NULL, options, and sockaddr_un::sun_path.
Referenced by clearTimeout(), Ipc::Port::doListen(), Ipc::ImportFdIntoComm(), setTimeout(), timedout(), Ipc::UdsSender::write(), and Ipc::UdsSender::wrote().
◆ 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.
◆ 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()
|
protectedvirtualinherited |
Reimplemented in Adaptation::Icap::ModXact, ConnStateData, ClientHttpRequest, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Client, Ipc::UdsSender, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Downloader, Log::TcpLogger, Adaptation::Iterator, Comm::TcpAcceptor, Ipc::Forwarder, Ipc::Inquirer, Rock::HeaderUpdater, Mgr::StoreToCommWriter, Rock::Rebuild, PeerPoolMgr, Mgr::Inquirer, Server, Snmp::Inquirer, BodySink, Comm::ConnOpener, and Ipc::Port.
Definition at line 96 of file AsyncJob.cc.
Referenced by AsyncJob::done(), BodySink::doneAll(), Comm::ConnOpener::doneAll(), Server::doneAll(), PeerPoolMgr::doneAll(), Rock::Rebuild::doneAll(), Rock::HeaderUpdater::doneAll(), Comm::TcpAcceptor::doneAll(), Adaptation::Iterator::doneAll(), Log::TcpLogger::doneAll(), Downloader::doneAll(), Adaptation::Icap::Launcher::doneAll(), Ipc::UdsSender::doneAll(), Adaptation::Ecap::XactionRep::doneAll(), Client::doneAll(), Security::PeerConnector::doneAll(), Adaptation::Icap::Xaction::doneAll(), Adaptation::Icap::ServiceRep::doneAll(), ClientHttpRequest::doneAll(), and ConnStateData::doneAll().
◆ 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(), 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(), 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().
◆ noteTimeout()
|
private |
Definition at line 67 of file UdsOp.cc.
References timedout().
Referenced by setTimeout(), and timedout().
◆ operator=()
◆ setOptions()
|
protected |
Definition at line 35 of file UdsOp.cc.
References options.
Referenced by Ipc::Port::Port(), and timedout().
◆ setTimeout()
|
protected |
Definition at line 54 of file UdsOp.cc.
References asyncCall(), commSetConnTimeout(), conn(), handler(), and noteTimeout().
Referenced by Ipc::Strand::registerSelf(), Ipc::UdsSender::start(), and timedout().
◆ 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(), FwdState::connectDone(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), 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(), 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()
|
protectedvirtualinherited |
Reimplemented in ConnStateData, Adaptation::Icap::ModXact, Ftp::Client, Ftp::Gateway, Ftp::Server, HttpStateData, Security::PeerConnector, Adaptation::Ecap::XactionRep, Ipc::UdsSender, Adaptation::AccessCheck, Adaptation::Icap::Launcher, Downloader, Adaptation::Icap::Xaction, Ftp::Relay, Log::TcpLogger, Adaptation::Iterator, Comm::TcpAcceptor, Ipc::Coordinator, Ipc::Forwarder, Comm::ConnOpener, Ipc::Inquirer, Http::One::Server, Rock::HeaderUpdater, Mgr::StoreToCommWriter, Rock::Rebuild, Mgr::Inquirer, PeerPoolMgr, Server, Snmp::Inquirer, Ipc::Strand, Adaptation::Icap::OptXact, Ipc::Port, Mgr::ActionWriter, and Mgr::Filler.
Definition at line 43 of file AsyncJob.cc.
Referenced by Ipc::Port::start(), PeerPoolMgr::start(), AsyncJob::Start(), Adaptation::Iterator::start(), Adaptation::Icap::Xaction::start(), Adaptation::Icap::Launcher::start(), Adaptation::AccessCheck::start(), Ipc::UdsSender::start(), Security::PeerConnector::start(), and ConnStateData::start().
◆ status()
|
protectedvirtualinherited |
for debugging, starts with space
Reimplemented in Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, 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()
|
inlineprotectedvirtualinherited |
Reimplemented in Adaptation::Icap::ModXactLauncher, Adaptation::Icap::ModXact, ConnStateData, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Client, Ipc::UdsSender, Adaptation::Icap::Launcher, Ftp::Relay, Log::TcpLogger, Adaptation::Iterator, Downloader, Comm::TcpAcceptor, Adaptation::Initiate, Ipc::Forwarder, Adaptation::Icap::OptXact, Comm::ConnOpener, Rock::HeaderUpdater, Ipc::Inquirer, Mgr::Forwarder, Rock::Rebuild, Mgr::StoreToCommWriter, PeerPoolMgr, Server, Snmp::Forwarder, and Mgr::Filler.
Definition at line 54 of file AsyncJob.h.
References AsyncJob::callEnd(), AsyncJob::callException(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::status(), and AsyncJob::~AsyncJob().
Referenced by AsyncJob::callEnd(), PeerPoolMgr::swanSong(), Server::swanSong(), Rock::HeaderUpdater::swanSong(), Comm::ConnOpener::swanSong(), Comm::TcpAcceptor::swanSong(), Log::TcpLogger::swanSong(), Ipc::UdsSender::swanSong(), Client::swanSong(), and Security::PeerConnector::swanSong().
◆ timedout()
|
inlineprotectedvirtual |
Reimplemented in Ipc::UdsSender, and Ipc::Strand.
Definition at line 39 of file UdsOp.h.
References clearTimeout(), conn(), noteTimeout(), p, setOptions(), and setTimeout().
Referenced by noteTimeout().
◆ toCbdata()
|
pure virtualinherited |
Implemented in ClientHttpRequest, HttpStateData, and BodySink.
Referenced by AsyncJob::callException(), AsyncJob::callStart(), and CbdataParent::~CbdataParent().
Member Data Documentation
◆ address
| struct sockaddr_un Ipc::UdsOp::address |
Definition at line 36 of file UdsOp.h.
Referenced by conn(), and Ipc::UdsSender::UdsSender().
◆ conn_
|
private |
◆ 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().
◆ options
|
private |
Definition at line 54 of file UdsOp.h.
Referenced by conn(), and setOptions().
◆ stopReason
|
protectedinherited |
Definition at line 69 of file AsyncJob.h.
Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and Security::PeerConnector::status().
◆ 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: