#include <RockHeaderUpdater.h>

Inheritance diagram for Rock::HeaderUpdater:
Collaboration diagram for Rock::HeaderUpdater:

Classes

class  IoCbParams
 

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 HeaderUpdater (const Rock::SwapDir::Pointer &aStore, const Ipc::StoreMapUpdate &update)
 
virtual ~HeaderUpdater () override=default
 
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 () override
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const override
 whether positive goal has been reached More...
 
virtual void swanSong () override
 
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...
 

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...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 CBDATA_CHILD (HeaderUpdater)
 
void startReading ()
 
void stopReading (const char *why)
 
void readMore (const char *why)
 
void noteRead (const IoCbParams result)
 
void noteDoneReading (int errflag)
 
void parseReadBytes ()
 
void startWriting ()
 
void noteDoneWriting (int errflag)
 

Private Attributes

Rock::SwapDir::Pointer store
 cache_dir where the entry is stored More...
 
Ipc::StoreMapUpdate update
 Ipc::StoreMap update reservation. More...
 
StoreIOState::Pointer reader
 reads old headers and old data More...
 
StoreIOState::Pointer writer
 writes new headers and old data More...
 
SBuf readerBuffer
 I/O buffer for a single read operation. More...
 
SBuf exchangeBuffer
 bytes read but not yet discarded or written More...
 
uint64_t bytesRead
 total entry bytes read from Store so far More...
 
int staleSwapHeaderSize
 stored size of the stale entry metadata More...
 
SlotId staleSplicingPointNext
 non-updatable old HTTP body suffix start More...
 

Static Private Attributes

static StoreIOState::STRCB NoteRead
 
static StoreIOState::STIOCB NoteDoneReading
 
static StoreIOState::STIOCB NoteDoneWriting
 

Detailed Description

Updates HTTP headers of a single Rock store entry:

  • reads old body data in the same slot as the last old headers slot, if any
  • writes new headers (1+ slots)
  • writes old data (0-2 slots)
  • chains the new entry prefix (1+ slots) to the old entry suffix (0+ slots)

Definition at line 26 of file RockHeaderUpdater.h.

Member Typedef Documentation

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

Rock::HeaderUpdater::HeaderUpdater ( const Rock::SwapDir::Pointer aStore,
const Ipc::StoreMapUpdate update 
)

Definition at line 20 of file RockHeaderUpdater.cc.

virtual Rock::HeaderUpdater::~HeaderUpdater ( )
overridevirtualdefault

Member Function Documentation

void AsyncJob::callEnd ( )
virtualinherited
void AsyncJob::callStart ( AsyncCall call)
inherited
bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

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

Rock::HeaderUpdater::CBDATA_CHILD ( HeaderUpdater  )
private
void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited
bool AsyncJob::done ( ) const
protectedinherited

Definition at line 90 of file AsyncJob.cc.

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

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

bool Rock::HeaderUpdater::doneAll ( ) const
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 34 of file RockHeaderUpdater.cc.

References AsyncJob::doneAll().

void Rock::HeaderUpdater::noteDoneReading ( int  errflag)
private

Definition at line 153 of file RockHeaderUpdater.cc.

References debugs, and Must.

void Rock::HeaderUpdater::noteDoneWriting ( int  errflag)
private
void Rock::HeaderUpdater::noteRead ( const IoCbParams  result)
private
void Rock::HeaderUpdater::parseReadBytes ( )
private

Definition at line 240 of file RockHeaderUpdater.cc.

References StoreMetaUnpacker::checkBuffer(), debugs, headersEnd(), and Must.

void Rock::HeaderUpdater::readMore ( const char *  why)
private

Definition at line 128 of file RockHeaderUpdater.cc.

References debugs, Must, and storeRead().

void Rock::HeaderUpdater::start ( )
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 63 of file RockHeaderUpdater.cc.

References Must.

void Rock::HeaderUpdater::startReading ( )
private

Definition at line 72 of file RockHeaderUpdater.cc.

void Rock::HeaderUpdater::startWriting ( )
private
void Rock::HeaderUpdater::stopReading ( const char *  why)
private
void Rock::HeaderUpdater::swanSong ( )
overrideprotectedvirtual
virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

uint64_t Rock::HeaderUpdater::bytesRead
private

Definition at line 69 of file RockHeaderUpdater.h.

SBuf Rock::HeaderUpdater::exchangeBuffer
private

Definition at line 68 of file RockHeaderUpdater.h.

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 70 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall
protectedinherited
void Rock::HeaderUpdater::NoteDoneReading
staticprivate

Definition at line 48 of file RockHeaderUpdater.h.

void Rock::HeaderUpdater::NoteDoneWriting
staticprivate

Definition at line 49 of file RockHeaderUpdater.h.

void Rock::HeaderUpdater::NoteRead
staticprivate

Definition at line 47 of file RockHeaderUpdater.h.

StoreIOState::Pointer Rock::HeaderUpdater::reader
private

Definition at line 64 of file RockHeaderUpdater.h.

SBuf Rock::HeaderUpdater::readerBuffer
private

Definition at line 67 of file RockHeaderUpdater.h.

SlotId Rock::HeaderUpdater::staleSplicingPointNext
private

Definition at line 73 of file RockHeaderUpdater.h.

int Rock::HeaderUpdater::staleSwapHeaderSize
private

Definition at line 71 of file RockHeaderUpdater.h.

const char* AsyncJob::stopReason
protectedinherited
Rock::SwapDir::Pointer Rock::HeaderUpdater::store
private

Definition at line 61 of file RockHeaderUpdater.h.

Ipc::StoreMapUpdate Rock::HeaderUpdater::update
private

Definition at line 62 of file RockHeaderUpdater.h.

StoreIOState::Pointer Rock::HeaderUpdater::writer
private

Definition at line 65 of file RockHeaderUpdater.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors