Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Mgr::StoreToCommWriter Class Referenceabstract

#include <StoreToCommWriter.h>

Inheritance diagram for Mgr::StoreToCommWriter:
Inheritance graph
[legend]
Collaboration diagram for Mgr::StoreToCommWriter:
Collaboration graph
[legend]

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

Public Member Functions

 StoreToCommWriter (const Comm::ConnectionPointer &conn, StoreEntry *anEntry)
 
virtual ~StoreToCommWriter ()
 
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

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...
 
void scheduleStoreCopy ()
 request more action results from the store More...
 
void noteStoreCopied (StoreIOBuffer ioBuf)
 receive some action results from the store More...
 
void scheduleCommWrite (const StoreIOBuffer &ioBuf)
 tell Comm to write action results More...
 
void noteCommWrote (const CommIoCbParams &params)
 called by Comm after the action results are written More...
 
void noteCommClosed (const CommCloseCbParams &params)
 called by Comm if the client socket got closed More...
 
void close ()
 closes the local connection to the HTTP client, if any 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...
 

Static Protected Member Functions

static void NoteStoreCopied (void *data, StoreIOBuffer ioBuf)
 
static void HandleStoreAbort (StoreToCommWriter *param)
 called by Store if the entry is no longer usable More...
 

Protected Attributes

Comm::ConnectionPointer clientConnection
 HTTP client descriptor. More...
 
StoreEntry * entry
 store entry with the cache manager response More...
 
store_client * sc
 our registration with the store More...
 
int64_t writeOffset
 number of bytes written to the client More...
 
AsyncCall::Pointer closer
 comm_close handler More...
 
char buffer [HTTP_REQBUF_SZ]
 action results; Store fills, Comm writes 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...
 

Private Member Functions

 CBDATA_CLASS (StoreToCommWriter)
 

Detailed Description

manages receive-from-store, write-to-comm, receive-... sequence for the given StoreEntry and client FD

Definition at line 29 of file StoreToCommWriter.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ StoreToCommWriter()

Mgr::StoreToCommWriter::StoreToCommWriter ( const Comm::ConnectionPointer &  conn,
StoreEntry *  anEntry 
)

Definition at line 24 of file StoreToCommWriter.cc.

References asyncCall(), clientConnection, closer, comm_add_close_handler(), debugs, Comm::Connection::fd, HERE(), and noteCommClosed().

◆ ~StoreToCommWriter()

Mgr::StoreToCommWriter::~StoreToCommWriter ( )
virtual

Definition at line 34 of file StoreToCommWriter.cc.

References assert, debugs, HERE(), and sc.

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

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

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

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, HERE(), AsyncJob::inCall, and NULL.

◆ CBDATA_CLASS()

Mgr::StoreToCommWriter::CBDATA_CLASS ( StoreToCommWriter  )
private

◆ close()

void Mgr::StoreToCommWriter::close ( )
protected

closes our copy of the client HTTP connection socket

Definition at line 44 of file StoreToCommWriter.cc.

References comm_remove_close_handler(), Comm::IsConnOpen(), and NULL.

◆ deleteThis()

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

◆ done()

bool AsyncJob::done ( ) const
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()

bool Mgr::StoreToCommWriter::doneAll ( ) const
protectedvirtual

Reimplemented from AsyncJob.

Definition at line 159 of file StoreToCommWriter.cc.

References STORE_OK.

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )
inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ HandleStoreAbort()

void Mgr::StoreToCommWriter::HandleStoreAbort ( StoreToCommWriter *  param)
staticprotected

Definition at line 167 of file StoreToCommWriter.cc.

References clientConnection, Comm::Connection::close(), and Comm::IsConnOpen().

Referenced by start().

◆ mustStop()

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

◆ noteCommClosed()

void Mgr::StoreToCommWriter::noteCommClosed ( const CommCloseCbParams &  params)
protected

Definition at line 131 of file StoreToCommWriter.cc.

References debugs, and HERE().

Referenced by StoreToCommWriter().

◆ noteCommWrote()

void Mgr::StoreToCommWriter::noteCommWrote ( const CommIoCbParams &  params)
protected

Definition at line 119 of file StoreToCommWriter.cc.

References debugs, CommCommonCbParams::fd, CommCommonCbParams::flag, HERE(), Must, NULL, Comm::OK, and CommIoCbParams::size.

Referenced by scheduleCommWrite().

◆ noteStoreCopied()

void Mgr::StoreToCommWriter::noteStoreCopied ( StoreIOBuffer  ioBuf)
protected

Definition at line 94 of file StoreToCommWriter.cc.

References debugs, StoreIOBuffer::error, StoreIOBuffer::flags, HERE(), StoreIOBuffer::length, and Must.

Referenced by NoteStoreCopied().

◆ NoteStoreCopied()

void Mgr::StoreToCommWriter::NoteStoreCopied ( void *  data,
StoreIOBuffer  ioBuf 
)
staticprotected

Definition at line 81 of file StoreToCommWriter.cc.

References asyncCall(), Must, noteStoreCopied(), NULL, and ScheduleCallHere.

◆ scheduleCommWrite()

void Mgr::StoreToCommWriter::scheduleCommWrite ( const StoreIOBuffer &  ioBuf)
protected

Definition at line 105 of file StoreToCommWriter.cc.

References asyncCall(), StoreIOBuffer::data, debugs, HERE(), Comm::IsConnOpen(), StoreIOBuffer::length, Must, noteCommWrote(), NULL, and Comm::Write().

◆ scheduleStoreCopy()

void Mgr::StoreToCommWriter::scheduleStoreCopy ( )
protected

Definition at line 71 of file StoreToCommWriter.cc.

References debugs, HERE(), Must, NULL, sc, and storeClientCopy().

◆ start()

void Mgr::StoreToCommWriter::start ( )
protectedvirtual

Reimplemented from AsyncJob.

Reimplemented in Mgr::Filler, and Mgr::ActionWriter.

Definition at line 56 of file StoreToCommWriter.cc.

References asyncCall(), cbdataDialer(), debugs, HandleStoreAbort(), HERE(), Comm::IsConnOpen(), Must, NULL, sc, and storeClientListAdd().

Referenced by Mgr::ActionWriter::start(), and Mgr::Filler::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().

◆ status()

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

void Mgr::StoreToCommWriter::swanSong ( )
protectedvirtual

Reimplemented from AsyncJob.

Reimplemented in Mgr::Filler.

Definition at line 143 of file StoreToCommWriter.cc.

References debugs, HERE(), NULL, sc, and storeUnregister().

Referenced by Mgr::Filler::swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in HttpStateData, ClientHttpRequest, and BodySink.

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

Member Data Documentation

◆ buffer

char Mgr::StoreToCommWriter::buffer[HTTP_REQBUF_SZ]
protected

Definition at line 69 of file StoreToCommWriter.h.

◆ clientConnection

Comm::ConnectionPointer Mgr::StoreToCommWriter::clientConnection
protected

Definition at line 62 of file StoreToCommWriter.h.

Referenced by StoreToCommWriter(), and HandleStoreAbort().

◆ closer

AsyncCall::Pointer Mgr::StoreToCommWriter::closer
protected

Definition at line 68 of file StoreToCommWriter.h.

Referenced by StoreToCommWriter().

◆ entry

StoreEntry* Mgr::StoreToCommWriter::entry
protected

Definition at line 64 of file StoreToCommWriter.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id
inherited

Definition at line 73 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

Definition at line 81 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ sc

store_client* Mgr::StoreToCommWriter::sc
protected

Definition at line 65 of file StoreToCommWriter.h.

◆ started_

bool AsyncJob::started_ = false
protectedinherited

Definition at line 83 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

Definition at line 79 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ swanSang_

bool AsyncJob::swanSang_ = false
protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ typeName

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

◆ writeOffset

int64_t Mgr::StoreToCommWriter::writeOffset
protected

Definition at line 66 of file StoreToCommWriter.h.

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors