Rock::HeaderUpdater Class Reference

#include <RockHeaderUpdater.h>

Inheritance diagram for Rock::HeaderUpdater:

Collaboration diagram for Rock::HeaderUpdater:

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

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

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

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(), and AsyncJob::deleteThis().

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

virtualinherited

Reimplemented in Adaptation::Icap::ModXact, ClientHttpRequest, 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(), and Adaptation::Icap::Xaction::callException().

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.

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

Definition at line 49 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed().

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 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(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

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

Definition at line 222 of file RockHeaderUpdater.cc.

References debugs, Must, Rock::IoState::splicingPoint, and Rock::IoState::writeableAnchor_.

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

private

Definition at line 111 of file RockHeaderUpdater.cc.

References Rock::HeaderUpdater::IoCbParams::buf, debugs, Must, and Rock::HeaderUpdater::IoCbParams::size.

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

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(), FwdState::connectDone(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), 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().

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

Definition at line 167 of file RockHeaderUpdater.cc.

References MemBuf::content(), MemBuf::contentSize(), debugs, Must, Rock::IoState::staleSplicingPointNext, StoreIOState::wroteAll, and xfree.

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, 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 AsyncJob::callEnd(), AsyncJob::callStart(), Comm::TcpAcceptor::status(), and Adaptation::Initiate::status().

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

private

Definition at line 83 of file RockHeaderUpdater.cc.

References debugs, Must, StoreIOState::readerDone, Rock::IoState::splicingPoint, and Rock::IoState::staleSplicingPointNext.

void Rock::HeaderUpdater::swanSong ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 40 of file RockHeaderUpdater.cc.

References StoreIOState::readerDone, AsyncJob::swanSong(), Rock::IoState::writeableAnchor_, and StoreIOState::writerGone.

virtual void* CbdataParent::toCbdata ( )

pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

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

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 72 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 71 of file AsyncJob.h.

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

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

Definition at line 69 of file AsyncJob.h.

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

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

private

Definition at line 61 of file RockHeaderUpdater.h.

const char* AsyncJob::typeName

protectedinherited

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), AsyncJob::mustStop(), Adaptation::Icap::Xaction::Xaction(), and AsyncJob::~AsyncJob().

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:

• src/fs/rock/RockHeaderUpdater.h
• src/fs/rock/RockHeaderUpdater.cc