provides Coordinator with a local cache manager response More...

#include <Filler.h>

Inheritance diagram for Mgr::Filler:
Collaboration diagram for Mgr::Filler:

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 Filler (const Action::Pointer &, const Comm::ConnectionPointer &, Ipc::RequestId)
 
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< AsyncJobid
 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...
 
StoreEntryentry
 store entry with the cache manager response More...
 
store_clientsc
 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 (Filler)
 

Private Attributes

Action::Pointer action
 action that will run() and sendResponse() More...
 
Ipc::RequestId requestId
 the ID of the Request we are responding to More...
 

Detailed Description

Definition at line 23 of file Filler.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Filler()

Mgr::Filler::Filler ( const Action::Pointer anAction,
const Comm::ConnectionPointer conn,
Ipc::RequestId  aRequestId 
)

Definition at line 21 of file Filler.cc.

References action, conn, and debugs.

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 102 of file AsyncJob.cc.

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

◆ CBDATA_CLASS()

Mgr::Filler::CBDATA_CLASS ( Filler  )
private

◆ close()

void Mgr::StoreToCommWriter::close ( )
protectedinherited

closes our copy of the client HTTP connection socket

Definition at line 45 of file StoreToCommWriter.cc.

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

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

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

Reimplemented from AsyncJob.

Definition at line 160 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)
staticprotectedinherited

◆ mustStop()

◆ noteCommClosed()

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

Definition at line 132 of file StoreToCommWriter.cc.

References debugs, and MYNAME.

Referenced by Mgr::StoreToCommWriter::StoreToCommWriter().

◆ noteCommWrote()

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

◆ noteStoreCopied()

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

◆ NoteStoreCopied()

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

◆ scheduleCommWrite()

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

◆ scheduleStoreCopy()

void Mgr::StoreToCommWriter::scheduleStoreCopy ( )
protectedinherited

Definition at line 72 of file StoreToCommWriter.cc.

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

◆ start()

void Mgr::Filler::start ( )
protectedvirtual

Reimplemented from Mgr::StoreToCommWriter.

Definition at line 31 of file Filler.cc.

References action(), debugs, Must, MYNAME, NULL, and Mgr::StoreToCommWriter::start().

◆ Start()

◆ status()

◆ swanSong()

void Mgr::Filler::swanSong ( )
protectedvirtual

Reimplemented from Mgr::StoreToCommWriter.

Definition at line 42 of file Filler.cc.

References action(), debugs, MYNAME, and Mgr::StoreToCommWriter::swanSong().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ action

Action::Pointer Mgr::Filler::action
private

Definition at line 36 of file Filler.h.

Referenced by Filler().

◆ buffer

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

Definition at line 69 of file StoreToCommWriter.h.

◆ clientConnection

Comm::ConnectionPointer Mgr::StoreToCommWriter::clientConnection
protectedinherited

◆ closer

AsyncCall::Pointer Mgr::StoreToCommWriter::closer
protectedinherited

Definition at line 68 of file StoreToCommWriter.h.

Referenced by Mgr::StoreToCommWriter::StoreToCommWriter().

◆ entry

StoreEntry* Mgr::StoreToCommWriter::entry
protectedinherited

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

◆ requestId

Ipc::RequestId Mgr::Filler::requestId
private

Definition at line 37 of file Filler.h.

◆ sc

store_client* Mgr::StoreToCommWriter::sc
protectedinherited

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

◆ swanSang_

bool AsyncJob::swanSang_ = false
protectedinherited

Definition at line 84 of file AsyncJob.h.

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

◆ typeName

◆ writeOffset

int64_t Mgr::StoreToCommWriter::writeOffset
protectedinherited

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