Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
BodySink Class Reference
Inheritance diagram for BodySink:
Inheritance graph
[legend]
Collaboration diagram for BodySink:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< BodyConsumer > Pointer
 

Public Member Functions

void * operator new (size_t size)
 
void operator delete (void *address)
 
void * toCbdata () noexcept
 
 BodySink (const BodyPipe::Pointer &bp)
 
virtual ~BodySink ()
 
virtual void noteMoreBodyDataAvailable (BodyPipe::Pointer bp)
 
virtual void noteBodyProductionEnded (BodyPipe::Pointer)
 
virtual void noteBodyProducerAborted (BodyPipe::Pointer)
 
bool doneAll () const
 whether positive goal has been reached 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 callException (const std::exception &e)
 called when the job throws during an async call More...
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Member Functions

void stopConsumingFrom (RefCount< BodyPipe > &)
 
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 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 Attributes

BodyPipe::Pointer body_pipe
 the pipe we are consuming from More...
 

Static Private Attributes

static cbdata_type CBDATA_BodySink = CBDATA_UNKNOWN
 

Detailed Description

Definition at line 16 of file BodyPipe.cc.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<BodyConsumer> BodyConsumer::Pointer
inherited

Definition at line 45 of file BodyPipe.h.

Constructor & Destructor Documentation

◆ BodySink()

BodySink::BodySink ( const BodyPipe::Pointer &  bp)
inline

Definition at line 21 of file BodyPipe.cc.

◆ ~BodySink()

virtual BodySink::~BodySink ( )
inlinevirtual

Definition at line 22 of file BodyPipe.cc.

References assert, and body_pipe.

Member Function Documentation

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

Reimplemented in Adaptation::Icap::ModXact, ClientHttpRequest, 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()

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

◆ 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 BodySink::doneAll ( ) const
inlinevirtual

Reimplemented from AsyncJob.

Definition at line 34 of file BodyPipe.cc.

References body_pipe, and AsyncJob::doneAll().

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

◆ noteBodyProducerAborted()

virtual void BodySink::noteBodyProducerAborted ( BodyPipe::Pointer  )
inlinevirtual

Implements BodyConsumer.

Definition at line 31 of file BodyPipe.cc.

References body_pipe, and BodyConsumer::stopConsumingFrom().

◆ noteBodyProductionEnded()

virtual void BodySink::noteBodyProductionEnded ( BodyPipe::Pointer  )
inlinevirtual

Implements BodyConsumer.

Definition at line 28 of file BodyPipe.cc.

References body_pipe, and BodyConsumer::stopConsumingFrom().

◆ noteMoreBodyDataAvailable()

virtual void BodySink::noteMoreBodyDataAvailable ( BodyPipe::Pointer  bp)
inlinevirtual

Implements BodyConsumer.

Definition at line 24 of file BodyPipe.cc.

References BodyPipe::buf(), BodyPipe::consume(), and MemBuf::contentSize().

◆ operator delete()

void BodySink::operator delete ( void *  address)
inline

Definition at line 18 of file BodyPipe.cc.

◆ operator new()

void* BodySink::operator new ( size_t  size)
inline

Definition at line 18 of file BodyPipe.cc.

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

void AsyncJob::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()

const char * AsyncJob::status ( ) const
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().

◆ stopConsumingFrom()

void BodyConsumer::stopConsumingFrom ( RefCount< BodyPipe > &  p)
protectedinherited

Definition at line 118 of file BodyPipe.cc.

References assert, BodyPipe::clearConsumer(), debugs, and NULL.

Referenced by Ftp::Relay::abortOnData(), Adaptation::Icap::ModXact::checkConsuming(), Client::cleanAdaptation(), Client::doneSendingRequestBody(), Client::endAdaptedBodyConsumption(), ClientHttpRequest::endRequestSatisfaction(), Adaptation::Ecap::XactionRep::forgetVb(), Client::handleAdaptedBodyProducerAborted(), Client::handleRequestBodyProducerAborted(), noteBodyProducerAborted(), ClientHttpRequest::noteBodyProducerAborted(), noteBodyProductionEnded(), Client::serverComplete(), Client::swanSong(), Adaptation::Ecap::XactionRep::swanSong(), and ClientHttpRequest::~ClientHttpRequest().

◆ swanSong()

virtual void AsyncJob::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().

◆ toCbdata()

void* BodySink::toCbdata ( )
inlinevirtualnoexcept

Implements CbdataParent.

Definition at line 18 of file BodyPipe.cc.

Member Data Documentation

◆ body_pipe

BodyPipe::Pointer BodySink::body_pipe
private

Definition at line 37 of file BodyPipe.cc.

Referenced by doneAll(), noteBodyProducerAborted(), noteBodyProductionEnded(), and ~BodySink().

◆ CBDATA_BodySink

cbdata_type BodySink::CBDATA_BodySink = CBDATA_UNKNOWN
staticprivate

Definition at line 18 of file BodyPipe.cc.

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

◆ stopReason

const char* AsyncJob::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

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

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors