Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Rock::HeaderUpdater Class Referenceabstract

#include <RockHeaderUpdater.h>

Inheritance diagram for Rock::HeaderUpdater:
Inheritance graph
[legend]
Collaboration diagram for Rock::HeaderUpdater:
Collaboration graph
[legend]

Classes

class  IoCbParams
 

Public Types

typedef CbcPointer< AsyncJob > Pointer
 

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< AsyncJob > id
 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

◆ Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer
inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ HeaderUpdater()

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

Definition at line 20 of file RockHeaderUpdater.cc.

◆ ~HeaderUpdater()

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

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 136 of file AsyncJob.cc.

References AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), HERE(), AsyncJob::inCall, NULL, AsyncJob::status(), AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), AsyncJob::deleteThis(), and AsyncJob::swanSong().

◆ callException()

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

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

Definition at line 127 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by Ipc::Inquirer::callException(), Ipc::Forwarder::callException(), Ftp::Server::callException(), Adaptation::Icap::Xaction::callException(), and AsyncJob::swanSong().

◆ callStart()

void AsyncJob::callStart ( AsyncCall &  call)
inherited

called just before the called method

Definition at line 114 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

Referenced by AsyncJob::swanSong().

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall &  call) const
inherited

Definition at line 101 of file AsyncJob.cc.

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

Referenced by AsyncJob::swanSong().

◆ CBDATA_CHILD()

Rock::HeaderUpdater::CBDATA_CHILD ( HeaderUpdater  )
private

◆ deleteThis()

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

Definition at line 49 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

Definition at line 90 of file AsyncJob.cc.

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

Referenced by Adaptation::Ecap::XactionRep::blockVirgin(), AsyncJob::callEnd(), Adaptation::AccessCheck::checkCandidates(), HappyConnOpener::checkForNewConnection(), Rock::Rebuild::checkpoint(), Downloader::downloadFinished(), Comm::TcpAcceptor::handleClosure(), Adaptation::Icap::OptXact::handleCommRead(), Ipc::Inquirer::handleRemoteAck(), Ipc::Inquirer::inquire(), Adaptation::Icap::Launcher::noteAdaptationAnswer(), Adaptation::AccessCheck::noteAnswer(), Adaptation::Icap::Launcher::noteInitiatorAborted(), Adaptation::Icap::Launcher::noteXactAbort(), Ipc::Inquirer::requestTimedOut(), Adaptation::Iterator::step(), Adaptation::AccessCheck::usedDynamicRules(), and Adaptation::Ecap::XactionRep::useVirgin().

◆ doneAll()

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

Reimplemented from AsyncJob.

Definition at line 34 of file RockHeaderUpdater.cc.

References AsyncJob::doneAll(), reader, and writer.

Referenced by noteDoneWriting().

◆ mustStop()

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

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(), Mgr::StoreToCommWriter::noteCommClosed(), Adaptation::Icap::Xaction::noteCommRead(), 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().

◆ noteDoneReading()

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

Definition at line 153 of file RockHeaderUpdater.cc.

References debugs, Must, AsyncJob::mustStop(), reader, and writer.

Referenced by readMore().

◆ noteDoneWriting()

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

Definition at line 252 of file RockHeaderUpdater.cc.

References debugs, doneAll(), Ipc::StoreMapUpdate::fresh, Must, reader, Rock::IoState::splicingPoint, Ipc::StoreMapUpdate::Edition::splicingPoint, store, update, Rock::IoState::writeableAnchor_, and writer.

Referenced by startWriting().

◆ noteRead()

void Rock::HeaderUpdater::noteRead ( const IoCbParams  result)
private

Definition at line 111 of file RockHeaderUpdater.cc.

References SBuf::append(), Rock::HeaderUpdater::IoCbParams::buf, bytesRead, debugs, exchangeBuffer, SBuf::length(), Must, parseReadBytes(), SBuf::rawAppendFinish(), readerBuffer, Rock::HeaderUpdater::IoCbParams::size, and stopReading().

Referenced by stopReading().

◆ parseReadBytes()

void Rock::HeaderUpdater::parseReadBytes ( )
private

Definition at line 270 of file RockHeaderUpdater.cc.

References StoreMetaUnpacker::checkBuffer(), SBuf::consume(), debugs, exchangeBuffer, headersEnd(), SBuf::length(), Must, SBuf::rawContent(), readMore(), staleSwapHeaderSize, startWriting(), and stopReading().

Referenced by noteRead().

◆ readMore()

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

Definition at line 128 of file RockHeaderUpdater.cc.

References bytesRead, CallJobHere1, SBuf::clear(), data, debugs, Must, NoteDoneReading, noteDoneReading(), NoteRead, SBuf::rawAppendStart(), reader, readerBuffer, store, and storeRead().

Referenced by parseReadBytes(), and startReading().

◆ Start()

AsyncJob::Pointer AsyncJob::Start ( AsyncJob *  job)
staticinherited

Definition at line 23 of file AsyncJob.cc.

References CallJobHere, and AsyncJob::start().

Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), TunnelStateData::connectedToPeer(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), FwdState::establishTunnelThruProxy(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Adaptation::Initiator::initiateAdaptation(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), HappyConnOpener::openFreshConnection(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeerIfNeeded(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ start()

void Rock::HeaderUpdater::start ( )
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 63 of file RockHeaderUpdater.cc.

References Ipc::StoreMapUpdate::entry, Ipc::StoreMapUpdate::fresh, Must, Ipc::StoreMapUpdate::stale, startReading(), and update.

◆ startReading()

void Rock::HeaderUpdater::startReading ( )
private

Definition at line 72 of file RockHeaderUpdater.cc.

References Ipc::StoreMapUpdate::entry, NoteDoneReading, reader, readMore(), store, and update.

Referenced by start().

◆ startWriting()

void Rock::HeaderUpdater::startWriting ( )
private

Definition at line 167 of file RockHeaderUpdater.cc.

References Ipc::StoreMapUpdate::Edition::anchor, Ipc::StoreMapAnchor::basics, CallJobHere1, SBuf::clear(), StoreIOState::close(), data, debugs, Ipc::StoreMapUpdate::entry, exchangeBuffer, Ipc::StoreMapUpdate::fresh, StoreEntry::getSerialisedMetaData(), SBuf::length(), StoreEntry::mem(), Must, NoteDoneWriting, noteDoneWriting(), SBuf::rawContent(), Rock::IoState::staleSplicingPointNext, staleSplicingPointNext, store, Ipc::StoreMapAnchor::Basics::swap_file_sz, StoreEntry::swap_file_sz, update, StoreIOState::write(), writer, StoreIOState::wroteAll, and xfree.

Referenced by parseReadBytes().

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Icap::ServiceRep, HappyConnOpener, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Http::Tunneler, Adaptation::Initiate, Comm::TcpAcceptor, and Ipc::Inquirer.

Definition at line 159 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by BodyPipe::buf(), AsyncJob::callEnd(), AsyncJob::callStart(), ClientRequestContext::clientAccessCheckDone(), ClientRequestContext::clientRedirectDone(), Ftp::Client::ctrlClosed(), Ftp::Relay::dataChannelConnected(), Ftp::Client::dataClosed(), Ftp::Client::dataComplete(), Ftp::Client::doneSendingRequestBody(), Ftp::Client::handleControlReply(), Ftp::Client::handleEpsvReply(), Ftp::Client::handlePasvReply(), Ftp::Client::parseControlReply(), Ftp::Relay::processReplyBody(), Ftp::Gateway::processReplyBody(), Ftp::Relay::readTransferDoneReply(), Ftp::Client::sendEprt(), Ftp::Client::sendPassive(), Adaptation::Initiate::status(), Comm::TcpAcceptor::status(), and AsyncJob::swanSong().

◆ stopReading()

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

Definition at line 83 of file RockHeaderUpdater.cc.

References buf, CallJobHere1, StoreIOState::close(), data, debugs, Must, NoteRead, noteRead(), reader, StoreIOState::readerDone, Rock::IoState::splicingPoint, Ipc::StoreMapUpdate::Edition::splicingPoint, Ipc::StoreMapUpdate::stale, Rock::IoState::staleSplicingPointNext, staleSplicingPointNext, and update.

Referenced by noteRead(), and parseReadBytes().

◆ swanSong()

void Rock::HeaderUpdater::swanSong ( )
overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 40 of file RockHeaderUpdater.cc.

References StoreIOState::close(), Ipc::StoreMapUpdate::fresh, reader, StoreIOState::readerDone, Ipc::StoreMapUpdate::stale, store, AsyncJob::swanSong(), update, Rock::IoState::writeableAnchor_, writer, and StoreIOState::writerGone.

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

Member Data Documentation

◆ bytesRead

uint64_t Rock::HeaderUpdater::bytesRead
private

Definition at line 69 of file RockHeaderUpdater.h.

Referenced by noteRead(), and readMore().

◆ exchangeBuffer

SBuf Rock::HeaderUpdater::exchangeBuffer
private

Definition at line 68 of file RockHeaderUpdater.h.

Referenced by noteRead(), parseReadBytes(), and startWriting().

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

Definition at line 71 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), Adaptation::Icap::ModXact::callException(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), Log::TcpLogger::endGracefully(), Log::TcpLogger::handleClosure(), and AsyncJob::mustStop().

◆ NoteDoneReading

void Rock::HeaderUpdater::NoteDoneReading
staticprivate

Definition at line 48 of file RockHeaderUpdater.h.

Referenced by readMore(), and startReading().

◆ NoteDoneWriting

void Rock::HeaderUpdater::NoteDoneWriting
staticprivate

Definition at line 49 of file RockHeaderUpdater.h.

Referenced by startWriting().

◆ NoteRead

void Rock::HeaderUpdater::NoteRead
staticprivate

Definition at line 47 of file RockHeaderUpdater.h.

Referenced by readMore(), and stopReading().

◆ reader

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

Definition at line 64 of file RockHeaderUpdater.h.

Referenced by doneAll(), noteDoneReading(), noteDoneWriting(), readMore(), startReading(), stopReading(), and swanSong().

◆ readerBuffer

SBuf Rock::HeaderUpdater::readerBuffer
private

Definition at line 67 of file RockHeaderUpdater.h.

Referenced by noteRead(), and readMore().

◆ staleSplicingPointNext

SlotId Rock::HeaderUpdater::staleSplicingPointNext
private

Definition at line 73 of file RockHeaderUpdater.h.

Referenced by startWriting(), and stopReading().

◆ staleSwapHeaderSize

int Rock::HeaderUpdater::staleSwapHeaderSize
private

Definition at line 71 of file RockHeaderUpdater.h.

Referenced by parseReadBytes().

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

Definition at line 69 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), Http::Tunneler::status(), Security::PeerConnector::status(), and HappyConnOpener::status().

◆ store

Rock::SwapDir::Pointer Rock::HeaderUpdater::store
private

Definition at line 61 of file RockHeaderUpdater.h.

Referenced by noteDoneWriting(), readMore(), startReading(), startWriting(), and swanSong().

◆ typeName

const char* AsyncJob::typeName
protectedinherited

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), Adaptation::Icap::Xaction::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), Adaptation::Icap::Xaction::dieOnConnectionFailure(), Adaptation::Icap::Xaction::disableRepeats(), Adaptation::Icap::Xaction::disableRetries(), Adaptation::Icap::Xaction::handleCommTimedout(), Adaptation::Icap::Xaction::handleSecuredPeer(), AsyncJob::mustStop(), Adaptation::Icap::Xaction::openConnection(), Adaptation::Icap::Xaction::Xaction(), AsyncJob::~AsyncJob(), and Adaptation::Icap::Xaction::~Xaction().

◆ update

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

Definition at line 62 of file RockHeaderUpdater.h.

Referenced by noteDoneWriting(), start(), startReading(), startWriting(), stopReading(), and swanSong().

◆ writer

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

Definition at line 65 of file RockHeaderUpdater.h.

Referenced by doneAll(), noteDoneReading(), noteDoneWriting(), startWriting(), and swanSong().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors