Inheritance diagram for BodySink:

[legend]

Collaboration diagram for BodySink:

[legend]

Public Types
typedef CbcPointer< BodyConsumer >	Pointer

Public Member Functions
	BodySink (const BodyPipe::Pointer &bp)

	~BodySink () override

void	noteMoreBodyDataAvailable (BodyPipe::Pointer bp) override

void	noteBodyProductionEnded (BodyPipe::Pointer) override

void	noteBodyProducerAborted (BodyPipe::Pointer) override

bool	doneAll () const override
	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...

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	Start (const Pointer &job)

Public Attributes
const InstanceId< AsyncJob >	id
	job identifier 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...

bool	started_ = false
	Start() has finished successfully. More...

bool	swanSang_ = false
	swanSong() was called More...

Private Member Functions
	CBDATA_CHILD (BodySink)

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

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

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

BodySink::~BodySink ( )

inlineoverride

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 137 of file AsyncJob.cc.

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

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

◆ callException()

void AsyncJob::callException ( const std::exception & e )

virtualinherited

Reimplemented in ConnStateData, ClientHttpRequest, Adaptation::Icap::ModXact, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Ipc::Forwarder, Ipc::Inquirer, and Ftp::Server.

Definition at line 128 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by ConnStateData::callException(), Adaptation::Icap::Xaction::callException(), Ipc::Forwarder::callException(), Ipc::Inquirer::callException(), and Ftp::Server::callException().

◆ 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, and AsyncJob::inCall.

◆ CBDATA_CHILD()

BodySink::CBDATA_CHILD ( BodySink )

private

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 50 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed(), and AsyncJob::deleteThis().

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 91 of file AsyncJob.cc.

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

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

◆ doneAll()

bool BodySink::doneAll ( ) const

inlineoverridevirtual

Reimplemented from AsyncJob.

Definition at line 34 of file BodyPipe.cc.

References body_pipe, and AsyncJob::doneAll().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

◆ noteBodyProducerAborted()

void BodySink::noteBodyProducerAborted ( BodyPipe::Pointer )

inlineoverridevirtual

Implements BodyConsumer.

Definition at line 31 of file BodyPipe.cc.

References body_pipe, and BodyConsumer::stopConsumingFrom().

◆ noteBodyProductionEnded()

void BodySink::noteBodyProductionEnded ( BodyPipe::Pointer )

inlineoverridevirtual

Implements BodyConsumer.

Definition at line 28 of file BodyPipe.cc.

References body_pipe, and BodyConsumer::stopConsumingFrom().

◆ noteMoreBodyDataAvailable()

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

inlineoverridevirtual

Implements BodyConsumer.

Definition at line 24 of file BodyPipe.cc.

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

◆ start()

void AsyncJob::start ( )

protectedvirtualinherited

Reimplemented in Adaptation::AccessCheck, Adaptation::Ecap::XactionRep, Adaptation::Icap::Launcher, Adaptation::Icap::ModXact, Adaptation::Icap::OptXact, Adaptation::Icap::Xaction, Adaptation::Iterator, ConnStateData, Ftp::Client, Ftp::Gateway, Ftp::Relay, Http::Tunneler, Comm::ConnOpener, Comm::TcpAcceptor, Downloader, Rock::HeaderUpdater, Rock::Rebuild, HappyConnOpener, HttpStateData, Ipc::Coordinator, Ipc::Forwarder, Ipc::Inquirer, Ipc::Strand, Ipc::UdsSender, Log::TcpLogger, Mgr::ActionWriter, Mgr::Filler, Mgr::Inquirer, Mgr::StoreToCommWriter, PeerPoolMgr, Security::PeerConnector, Ftp::Server, Http::One::Server, Server, Snmp::Inquirer, and Ipc::Port.

Definition at line 44 of file AsyncJob.cc.

Referenced by Adaptation::AccessCheck::start(), Adaptation::Icap::Launcher::start(), Adaptation::Icap::Xaction::start(), Adaptation::Iterator::start(), ConnStateData::start(), Http::Tunneler::start(), Ipc::UdsSender::start(), PeerPoolMgr::start(), Security::PeerConnector::start(), Ipc::Port::start(), and AsyncJob::Start().

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