#include <BodyPipe.h>

Inheritance diagram for BodyConsumer:

[legend]

Collaboration diagram for BodyConsumer:

[legend]

Public Types
typedef CbcPointer< BodyConsumer >	Pointer

Public Member Functions
	BodyConsumer ()

virtual	~BodyConsumer ()

virtual void	noteMoreBodyDataAvailable (RefCount< BodyPipe > bp)=0

virtual void	noteBodyProductionEnded (RefCount< BodyPipe > bp)=0

virtual void	noteBodyProducerAborted (RefCount< BodyPipe > bp)=0

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

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

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

Detailed Description

Interface for those who want to consume body content from others. BodyConsumer is expected to register with an existing BodyPipe by calling BodyPipe::setConsumer(). One pipe cannot have more than one consumer.

Definition at line 42 of file BodyPipe.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<BodyConsumer> BodyConsumer::Pointer

Definition at line 45 of file BodyPipe.h.

Constructor & Destructor Documentation

◆ BodyConsumer()

BodyConsumer::BodyConsumer ( )

inline

Definition at line 47 of file BodyPipe.h.

◆ ~BodyConsumer()

virtual BodyConsumer::~BodyConsumer ( )

inlinevirtual

Definition at line 48 of file BodyPipe.h.

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.

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

protectedvirtualinherited

Reimplemented in Adaptation::AccessCheck, Adaptation::Ecap::XactionRep, Adaptation::Icap::Launcher, Adaptation::Icap::ModXact, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Adaptation::Iterator, BodySink, ConnStateData, ClientHttpRequest, Client, Http::Tunneler, Comm::ConnOpener, Comm::TcpAcceptor, Downloader, Ipc::Forwarder, Ipc::Inquirer, Ipc::Port, Ipc::UdsSender, Log::TcpLogger, Mgr::Inquirer, Mgr::StoreToCommWriter, PeerPoolMgr, Security::PeerConnector, Server, Snmp::Inquirer, Rock::HeaderUpdater, Rock::Rebuild, and HappyConnOpener.

Definition at line 97 of file AsyncJob.cc.

Referenced by AsyncJob::done(), Adaptation::Ecap::XactionRep::doneAll(), Adaptation::Icap::Launcher::doneAll(), Adaptation::Icap::ServiceRep::doneAll(), Adaptation::Icap::Xaction::doneAll(), Adaptation::Iterator::doneAll(), BodySink::doneAll(), ConnStateData::doneAll(), ClientHttpRequest::doneAll(), Client::doneAll(), Comm::ConnOpener::doneAll(), Comm::TcpAcceptor::doneAll(), Downloader::doneAll(), Ipc::UdsSender::doneAll(), Log::TcpLogger::doneAll(), PeerPoolMgr::doneAll(), Security::PeerConnector::doneAll(), Server::doneAll(), Rock::HeaderUpdater::doneAll(), and Rock::Rebuild::doneAll().

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

virtual void BodyConsumer::noteBodyProducerAborted ( RefCount< BodyPipe > bp )

pure virtual

Implemented in Adaptation::Icap::ModXact, BodySink, ClientHttpRequest, Client, and Adaptation::Ecap::XactionRep.

Referenced by BodyPipe::scheduleBodyEndNotification().

◆ noteBodyProductionEnded()

virtual void BodyConsumer::noteBodyProductionEnded ( RefCount< BodyPipe > bp )

pure virtual

Implemented in Adaptation::Icap::ModXact, BodySink, ClientHttpRequest, Client, and Adaptation::Ecap::XactionRep.

Referenced by BodyPipe::scheduleBodyEndNotification().

◆ noteMoreBodyDataAvailable()

virtual void BodyConsumer::noteMoreBodyDataAvailable ( RefCount< BodyPipe > bp )

pure virtual

Implemented in BodySink, Adaptation::Icap::ModXact, ClientHttpRequest, Client, and Adaptation::Ecap::XactionRep.

Referenced by BodyPipe::scheduleBodyDataNotification().

◆ 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, HttpStateData, Ipc::Coordinator, Ipc::Forwarder, Ipc::Inquirer, Ipc::Strand, Ipc::UdsSender, Log::TcpLogger, Mgr::ActionWriter, Mgr::Filler, Mgr::Inquirer, Mgr::StoreToCommWriter, PeerPoolMgr, Security::PeerConnector, Http::One::Server, Server, Snmp::Inquirer, Rock::HeaderUpdater, Rock::Rebuild, HappyConnOpener, Ftp::Server, 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().