#include <StoreToCommWriter.h>

Inheritance diagram for Mgr::StoreToCommWriter:
Collaboration diagram for Mgr::StoreToCommWriter:

Public Types

typedef CbcPointer< AsyncJobPointer

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

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 Abort (void *param)
 called by Store if the entry is no longer usable More...

Protected Attributes

Comm::ConnectionPointer clientConnection
 HTTP client descriptor. More...
 store entry with the cache manager response More...
 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...
const InstanceId< AsyncJobid
 job identifier 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 28 of file StoreToCommWriter.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ StoreToCommWriter()

Mgr::StoreToCommWriter::StoreToCommWriter ( const Comm::ConnectionPointer conn,
StoreEntry anEntry 

◆ ~StoreToCommWriter()

Mgr::StoreToCommWriter::~StoreToCommWriter ( )

Definition at line 33 of file StoreToCommWriter.cc.

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

Member Function Documentation

◆ Abort()

void Mgr::StoreToCommWriter::Abort ( void *  param)

Definition at line 161 of file StoreToCommWriter.cc.

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

Referenced by start().

◆ callEnd()

void AsyncJob::callEnd ( )

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

Referenced by AsyncJob::swanSong().


Mgr::StoreToCommWriter::CBDATA_CLASS ( StoreToCommWriter  )

◆ close()

void Mgr::StoreToCommWriter::close ( )

closes our copy of the client HTTP connection socket

Definition at line 43 of file StoreToCommWriter.cc.

References clientConnection, Comm::Connection::close(), closer, comm_remove_close_handler(), Comm::Connection::fd, Comm::IsConnOpen(), and NULL.

Referenced by swanSong(), and ~StoreToCommWriter().

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ done()

◆ doneAll()

bool Mgr::StoreToCommWriter::doneAll ( ) const

Reimplemented from AsyncJob.

Definition at line 153 of file StoreToCommWriter.cc.

References entry, StoreEntry::objectLen(), STORE_OK, StoreEntry::store_status, and writeOffset.

Referenced by noteCommWrote(), and noteStoreCopied().

◆ mustStop()

void AsyncJob::mustStop ( const char *  aReason)

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(), Http::Tunneler::handleConnectionClosure(), 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(), 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().

◆ noteCommClosed()

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

◆ noteCommWrote()

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

◆ noteStoreCopied()

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

◆ NoteStoreCopied()

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

Definition at line 79 of file StoreToCommWriter.cc.

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

Referenced by scheduleStoreCopy().

◆ scheduleCommWrite()

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

◆ scheduleStoreCopy()

void Mgr::StoreToCommWriter::scheduleStoreCopy ( )

Definition at line 69 of file StoreToCommWriter.cc.

References buffer, debugs, entry, HERE(), Must, NoteStoreCopied(), NULL, sc, storeClientCopy(), and writeOffset.

Referenced by noteCommWrote(), and start().

◆ start()

void Mgr::StoreToCommWriter::start ( )

◆ Start()

◆ status()

◆ swanSong()

void Mgr::StoreToCommWriter::swanSong ( )

Reimplemented from AsyncJob.

Reimplemented in Mgr::Filler.

Definition at line 137 of file StoreToCommWriter.cc.

References close(), debugs, entry, HERE(), NULL, sc, storeUnregister(), StoreEntry::unlock(), and StoreEntry::unregisterAbort().

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

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ buffer

char Mgr::StoreToCommWriter::buffer[HTTP_REQBUF_SZ]

Definition at line 68 of file StoreToCommWriter.h.

Referenced by scheduleStoreCopy().

◆ clientConnection

Comm::ConnectionPointer Mgr::StoreToCommWriter::clientConnection

◆ closer

AsyncCall::Pointer Mgr::StoreToCommWriter::closer

Definition at line 67 of file StoreToCommWriter.h.

Referenced by close(), and StoreToCommWriter().

◆ entry

StoreEntry* Mgr::StoreToCommWriter::entry

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 72 of file AsyncJob.h.

◆ inCall

◆ sc

store_client* Mgr::StoreToCommWriter::sc

Definition at line 64 of file StoreToCommWriter.h.

Referenced by scheduleStoreCopy(), start(), swanSong(), and ~StoreToCommWriter().

◆ stopReason

const char* AsyncJob::stopReason

◆ typeName

◆ writeOffset

int64_t Mgr::StoreToCommWriter::writeOffset

Definition at line 65 of file StoreToCommWriter.h.

Referenced by doneAll(), noteCommWrote(), and scheduleStoreCopy().

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






Web Site Translations