PrecomputedCodeContext Class Reference

CodeContext with constant details known at construction time. More...

#include <PrecomputedCodeContext.h>

Inheritance diagram for PrecomputedCodeContext:

Collaboration diagram for PrecomputedCodeContext:

Public Types
typedef RefCount< PrecomputedCodeContext >	Pointer

Public Member Functions
	PrecomputedCodeContext (const char *gist, const SBuf &detail)
ScopedId	codeContextGist () const override
std::ostream &	detailCodeContext (std::ostream &os) const override
	appends human-friendly context description line(s) to a cache.log record More...

Static Public Member Functions
static const Pointer &	Current ()
static void	Reset ()
	forgets the current context, setting it to nil/unknown More...
static void	Reset (const Pointer)
	changes the current context; nil argument sets it to nil/unknown More...

Public Attributes
Stopwatch	busyTime
	time spent in this context (see also: busy_time) More...

Static Private Member Functions
static void	ForgetCurrent ()
static void	Entering (const Pointer &codeCtx)
static void	Leaving ()

Private Attributes
const char *	gist_
	the id used in codeContextGist() More...
const SBuf	detail_
	the detail used in detailCodeContext() More...

Detailed Description

Definition at line 19 of file PrecomputedCodeContext.h.

Member Typedef Documentation

Pointer

typedef RefCount<PrecomputedCodeContext> PrecomputedCodeContext::Pointer

Definition at line 22 of file PrecomputedCodeContext.h.

Constructor & Destructor Documentation

PrecomputedCodeContext()

PrecomputedCodeContext::PrecomputedCodeContext ( const char *  gist, const SBuf &  detail  )

inline

Definition at line 24 of file PrecomputedCodeContext.h.

Member Function Documentation

codeContextGist()

ScopedId PrecomputedCodeContext::codeContextGist ( ) const

inlineoverridevirtual

Returns

a small, permanent ID of the current context gists persist forever and are suitable for passing to other SMP workers

Implements CodeContext.

Definition at line 28 of file PrecomputedCodeContext.h.

References gist_.

Current()

const CodeContext::Pointer & CodeContext::Current ( )

staticinherited

Returns

the known global context or, to indicate unknown context, nil

Definition at line 33 of file CodeContext.cc.

References Instance().

Referenced by CallAndRestore_(), CallSubscription< Call_ >::callback(), CallContextCreator(), clientConnectionsClose(), clientHttpConnectionsOpen(), commStartHalfClosedMonitor(), CurrentCodeContextDetail(), HappyOrderEnforcer::enqueue(), CommQuotaQueue::enqueue(), StoreEntry::invokeHandlers(), neighborsUdpPing(), peerDnsRefreshStart(), Security::KeyLog::record(), CodeContext::Reset(), ScheduleCall(), Ftp::StartListening(), Ftp::StopListening(), tunnelDelayedClientRead(), and tunnelDelayedServerRead().

detailCodeContext()

std::ostream& PrecomputedCodeContext::detailCodeContext ( std::ostream &  os ) const

inlineoverridevirtual

Implements CodeContext.

Definition at line 29 of file PrecomputedCodeContext.h.

References detail_, and Debug::Extra().

Entering()

void CodeContext::Entering ( const Pointer &  codeCtx )

staticprivateinherited

Switches the current context to the given known context. Improves debugging output by replacing omni-directional "Reset" with directional "Entering".

Definition at line 55 of file CodeContext.cc.

References CodeContext::busyTime, CodeContext::codeContextGist(), debugs, CodeContext::ForgetCurrent(), Instance(), and Stopwatch::resume().

Referenced by CodeContext::Reset().

ForgetCurrent()

void CodeContext::ForgetCurrent ( )

staticprivateinherited

Forgets the current known context, possibly triggering its destruction. Preserves the gist of the being-forgotten context during its destruction. Knows nothing about the next context – the caller must set it.

Definition at line 42 of file CodeContext.cc.

References assert, FadingCodeContext::gist, and Instance().

Referenced by CodeContext::Entering(), and CodeContext::Leaving().

Leaving()

void CodeContext::Leaving ( )

staticprivateinherited

Forgets the current known context. Improves debugging output by replacing omni-directional "Reset" with directional "Leaving".

Definition at line 68 of file CodeContext.cc.

References debugs, CodeContext::ForgetCurrent(), and Instance().

Referenced by CodeContext::Reset().

Reset() [1/2]

void CodeContext::Reset ( )

staticinherited

Definition at line 77 of file CodeContext.cc.

References Instance(), and CodeContext::Leaving().

Referenced by CallAndRestore_(), CallContextCreator(), checkTimeouts(), clientConnectionsClose(), clientHttpConnectionsOpen(), ClientHttpRequest::ClientHttpRequest(), CodeContextGuard::CodeContextGuard(), comm_close_complete(), Http::Stream::finished(), AsyncCallQueue::fire(), StoreEntry::invokeHandlers(), neighborsUdpPing(), peerCountMcastPeersCreateAndSend(), peerDnsRefreshStart(), ConnStateData::postHttpsAccept(), Ftp::StartListening(), Ftp::StopListening(), tunnelDelayedClientRead(), tunnelDelayedServerRead(), and CodeContextGuard::~CodeContextGuard().

Reset() [2/2]

void CodeContext::Reset ( const Pointer  codeCtx )

staticinherited

Definition at line 84 of file CodeContext.cc.

References CodeContext::Current(), CodeContext::Entering(), and CodeContext::Leaving().

Member Data Documentation

busyTime

Stopwatch CodeContext::busyTime

inherited

Definition at line 76 of file CodeContext.h.

Referenced by Format::Format::assemble(), and CodeContext::Entering().

detail_

const SBuf PrecomputedCodeContext::detail_

private

Definition at line 33 of file PrecomputedCodeContext.h.

Referenced by detailCodeContext().

gist_

const char* PrecomputedCodeContext::gist_

private

Definition at line 32 of file PrecomputedCodeContext.h.

Referenced by codeContextGist().

---

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

• src/base/PrecomputedCodeContext.h