Mgr Namespace Reference

Cache Manager API.

Classes
class	Action
class	ActionCreator
class	ActionParams
	Cache Manager Action parameters extracted from the user request. More...
class	ActionPasswordList
	list of cachemgr password authorization definitions. Currently a POD. More...
class	ActionProfile
	hard-coded Cache Manager action configuration, including Action creator More...
class	ActionWriter
class	ClassActionCreator
	creates Action using supplied Action::Create method and command More...
class	Command
	combined hard-coded action profile with user-supplied action parameters More...
class	CountersAction
	implement aggregated 'counters' action More...
class	CountersActionData
	store traffic and resource counters More...
class	Filler
	provides Coordinator with a local cache manager response More...
class	Forwarder
class	FunAction
class	FunActionCreator
	creates FunAction using ActionCreator API More...
class	IndexAction
class	InfoAction
	implement aggregated 'info' action More...
class	InfoActionData
class	Inquirer
class	IntervalAction
	implement aggregated interval actions More...
class	IntervalActionData
class	IntParam
class	IoAction
	implement aggregated 'io' action More...
class	IoActionData
	store size histograms of network read() from peer server More...
class	MenuAction
	returns available Cache Manager actions and their access requirements More...
class	OfflineToggleAction
	changes offline mode More...
class	QueryParam
class	QueryParams
class	ReconfigureAction
	reconfigures Squid More...
class	Request
	cache manager request More...
class	Response
class	RotateAction
	starts log rotation More...
class	ServiceTimesAction
	implement aggregated 'service_times' action More...
class	ServiceTimesActionData
	store service times for 5 and 60 min More...
class	ShutdownAction
	shuts Squid down More...
class	StoreIoAction
	implement aggregated 'store_io' action More...
class	StoreIoActionData
	Store IO interface data. More...
class	StoreToCommWriter
class	StringParam

Typedefs
typedef RefCount< Action >	ActionPointer
typedef RefCount< ActionProfile >	ActionProfilePointer
typedef RefCount< ActionCreator >	ActionCreatorPointer
typedef RefCount< Command >	CommandPointer
typedef ActionPointer()	ClassActionCreationHandler(const CommandPointer &cmd)

Enumerations
enum	Protected {   Protected::no,   Protected::yes }
	whether default cachemgr_passwd configuration denies the Action More...
enum	Atomic {   Atomic::no,   Atomic::yes }
	whether Action::dump() writes the entire report before returning More...
enum	Format {   Format::informal,   Format::yaml }
	whether Action report uses valid YAML or unspecified/legacy formatting More...

Functions
void	OpenKidSection (StoreEntry *, Format)
void	CloseKidSection (StoreEntry *, Format)
std::ostream &	operator<< (std::ostream &os, const ActionProfile &profile)
void	RegisterBasics ()
	Registers profiles for the actions above; TODO: move elsewhere? More...
std::ostream &	operator<< (std::ostream &, const Command &)
void	RegisterAction (char const *action, char const *desc, OBJH *handler, Protected, Atomic, Format)
void	RegisterAction (const char *const action, const char *const desc, OBJH *handler, int pw_req_flag, int atomic)
	wrapper for legacy Format-unaware function-based action registration code More...
void	RegisterAction (char const *action, char const *desc, ClassActionCreationHandler *handler, Protected, Atomic, Format)
void	RegisterAction (const char *const action, const char *const desc, ClassActionCreationHandler *handler, int pw_req_flag, int atomic)
	wrapper for legacy Format-unaware class-based action registration code More...

Typedef Documentation

ActionCreatorPointer

typedef RefCount<ActionCreator> Mgr::ActionCreatorPointer

Definition at line 33 of file forward.h.

ActionPointer

typedef RefCount<Action> Mgr::ActionPointer

Definition at line 29 of file forward.h.

ActionProfilePointer

typedef RefCount<ActionProfile> Mgr::ActionProfilePointer

Definition at line 32 of file forward.h.

ClassActionCreationHandler

typedef ActionPointer() Mgr::ClassActionCreationHandler(const CommandPointer &cmd)

Definition at line 36 of file forward.h.

CommandPointer

typedef RefCount<Command> Mgr::CommandPointer

Definition at line 34 of file forward.h.

Enumeration Type Documentation

Atomic

enum Mgr::Atomic

strong

Enumerator
no
yes

Definition at line 27 of file ActionFeatures.h.

Format

enum Mgr::Format

strong

Enumerator
informal
yaml

Definition at line 30 of file ActionFeatures.h.

Protected

enum Mgr::Protected

strong

Enumerator
no
yes

Definition at line 24 of file ActionFeatures.h.

Function Documentation

CloseKidSection()

void Mgr::CloseKidSection	(	StoreEntry *	entry,
		Format	format
	)

finishes writing a portion of the report specific to the current process

See also

OpenKidSection()

Definition at line 155 of file Action.cc.

References informal, KidIdentifier, storeAppendPrintf(), and yaml.

Referenced by Mgr::FunAction::dump(), Mgr::InfoAction::dump(), and statObjects().

OpenKidSection()

void Mgr::OpenKidSection	(	StoreEntry *	entry,
		Format	format
	)

starts writing a portion of the report specific to the current process

See also

CloseKidSection()

Definition at line 143 of file Action.cc.

References informal, KidIdentifier, storeAppendPrintf(), and yaml.

Referenced by Mgr::FunAction::dump(), and Mgr::InfoAction::dump().

operator<<() [1/2]

std::ostream & Mgr::operator<<	(	std::ostream &	os,
		const Command &	cmd
	)

Definition at line 16 of file Command.cc.

References Mgr::Command::profile.

operator<<() [2/2]

std::ostream& Mgr::operator<< ( std::ostream &  os, const ActionProfile &  profile  )

inline

Definition at line 50 of file ActionProfile.h.

References Mgr::ActionProfile::name.

RegisterAction() [1/4]

void Mgr::RegisterAction	(	char const *	action,
		char const *	desc,
		ClassActionCreationHandler *	handler,
		Protected	protection,
		Atomic	atomicity,
		Format	format
	)

Creates a class-based action profile and adds it to the cache manager collection (once across all calls with the same action name).

Definition at line 68 of file Registration.cc.

References debugs, CacheManager::GetInstance(), Acl::Make(), and CacheManager::registerProfile().

RegisterAction() [2/4]

void Mgr::RegisterAction	(	char const *	action,
		char const *	desc,
		OBJH *	handler,
		Protected	protection,
		Atomic	atomicity,
		Format	format
	)

Creates a function-based action profile and adds it to the cache manager collection (once across all calls with the same action name).

Definition at line 54 of file Registration.cc.

References debugs, CacheManager::GetInstance(), Acl::Make(), and CacheManager::registerProfile().

Referenced by asnRegisterWithCacheManager(), carpRegisterWithCacheManager(), commDevPollRegisterWithCacheManager(), commEPollRegisterWithCacheManager(), commPollRegisterWithCacheManager(), eventInit(), externalAclRegisterWithCacheManager(), fqdncacheRegisterWithCacheManager(), Ssl::GlobalContextStorage::GlobalContextStorage(), httpHeaderRegisterWithCacheManager(), Dns::Init(), Mem::Init(), ipcacheRegisterWithCacheManager(), neighborsRegisterWithCacheManager(), netdbInit(), Configuration::Parse(), peerSourceHashRegisterWithCacheManager(), peerUserHashRegisterWithCacheManager(), redirectInit(), refreshRegisterWithCacheManager(), RegisterAction(), RegisterBasics(), SBufStatsAction::RegisterWithCacheManager(), DiskDaemonDiskIOModule::registerWithCacheManager(), DiskThreadsIOStrategy::registerWithCacheManager(), AsyncJob::RegisterWithCacheManager(), DelayPools::RegisterWithCacheManager(), FwdState::RegisterWithCacheManager(), PconnModule::registerWithCacheManager(), statRegisterWithCacheManager(), storeDigestInit(), storeLogRegisterWithCacheManager(), storeRegisterWithCacheManager(), TestCacheManager::testRegister(), and ClientDbRr::useConfig().

RegisterAction() [3/4]

void Mgr::RegisterAction ( const char *const  action, const char *const  desc, ClassActionCreationHandler *  handler, int  pw_req_flag, int  atomic  )

inline

Definition at line 46 of file Registration.h.

References informal, no, RegisterAction(), and yes.

RegisterAction() [4/4]

void Mgr::RegisterAction ( const char *const  action, const char *const  desc, OBJH *  handler, int  pw_req_flag, int  atomic  )

inline

Definition at line 28 of file Registration.h.

References informal, no, RegisterAction(), and yes.

RegisterBasics()

void Mgr::RegisterBasics

(

)

Definition at line 150 of file BasicActions.cc.

References Mgr::IndexAction::Create(), Mgr::MenuAction::Create(), Mgr::ShutdownAction::Create(), Mgr::ReconfigureAction::Create(), Mgr::RotateAction::Create(), Mgr::OfflineToggleAction::Create(), and RegisterAction().

Referenced by CacheManager::GetInstance().