Cache Manager API
[Squid Components]

Collaboration diagram for Cache Manager API:

Classes
class	CacheManager
Modules
	Cache Manager intenal API (not for public use)
Functions
void	CacheManager::registerAction (char const *action, char const *desc, OBJH *handler, int pw_req_flag, int atomic)
void	CacheManager::registerAction (CacheManagerAction *anAction)
void	CacheManager::Start (int fd, HttpRequest *request, StoreEntry *entry)
static CacheManager *	CacheManager::GetInstance ()

---

Function Documentation

CacheManager * CacheManager::GetInstance

(

void

)

[static, inherited]

Singleton accessor method.

Definition at line 460 of file cache_manager.cc.

References debugs, and CacheManager::instance.

Referenced by asnRegisterWithCacheManager(), carpRegisterWithCacheManager(), cbdataRegisterWithCacheManager(), clientdbRegisterWithCacheManager(), commEPollRegisterWithCacheManager(), commPollRegisterWithCacheManager(), commSelectRegisterWithCacheManager(), dnsRegisterWithCacheManager(), eventInit(), externalAclRegisterWithCacheManager(), fqdncacheRegisterWithCacheManager(), FwdState::fwdStart(), httpHeaderRegisterWithCacheManager(), ipcacheRegisterWithCacheManager(), neighborsRegisterWithCacheManager(), netdbRegisterWithCacheManager(), parseConfigFile(), peerSourceHashRegisterWithCacheManager(), peerUserHashRegisterWithCacheManager(), redirectRegisterWithCacheManager(), refreshRegisterWithCacheManager(), Mem::RegisterWithCacheManager(), FwdState::RegisterWithCacheManager(), DiskThreadsIOStrategy::registerWithCacheManager(), DelayPools::RegisterWithCacheManager(), AuthNTLMConfig::registerWithCacheManager(), AuthNegotiateConfig::registerWithCacheManager(), AuthDigestConfig::registerWithCacheManager(), AuthBasicConfig::registerWithCacheManager(), statRegisterWithCacheManager(), storeDigestRegisterWithCacheManager(), storeLogRegisterWithCacheManager(), storeRegisterWithCacheManager(), testCacheManager::testCreate(), and testCacheManager::testRegister().

void CacheManager::registerAction

(

CacheManagerAction *

anAction

)

[inherited]

Registers a C++-style action, via a poiner to a subclass of a CacheManagerAction object, whose run() method will be invoked when CacheManager identifies that the user has requested the action.

Definition at line 82 of file cache_manager.cc.

References CacheManagerAction::action, action(), CacheManager::ActionsList, assert, debugs, CacheManager::findAction(), and NULL.

void CacheManager::registerAction	(	char const *	action,
		char const *	desc,
		OBJH *	handler,
		int	pw_req_flag,
		int	atomic
	)			[inherited]

Registers a C-style action, which is implemented as a pointer to a function taking as argument a pointer to a StoreEntry and returning void. Implemented via CacheManagerActionLegacy.

Definition at line 69 of file cache_manager.cc.

References debugs.

Referenced by asnRegisterWithCacheManager(), CacheManager::CacheManager(), cbdataRegisterWithCacheManager(), neighborsRegisterWithCacheManager(), parseConfigFile(), Mem::RegisterWithCacheManager(), statRegisterWithCacheManager(), storeRegisterWithCacheManager(), and testCacheManager::testRegister().

void CacheManager::Start	(	int	fd,
		HttpRequest *	request,
		StoreEntry *	entry
	)			[inherited]

Main entry point in the Cache Manager's activity. Gets called as part of the forward chain if the right URL is detected there. Initiates all needed internal work and renders the response.

Definition at line 262 of file cache_manager.cc.

References a, CacheManager::cachemgrStateData::action, assert, CacheManagerAction::atomic, StoreEntry::buffer(), ErrorState::BuildHttpReply(), CacheManager::CheckPassword(), StoreEntry::complete(), DBG_IMPORTANT, debugs, CacheManager::cachemgrStateData::entry, ERR_CACHE_MGR_ACCESS_DENIED, ERR_INVALID_URL, errorAppendEntry(), errorCon(), errorStateFree(), StoreEntry::expires, fd_table, CacheManager::findAction(), CacheManagerAction::flags, StoreEntry::flush(), HttpMsg::header, HTTP_NOT_FOUND, HTTP_OK, HTTP_UNAUTHORIZED, fde::ipaddr, StoreEntry::lock(), NULL, CacheManager::ParseHeaders(), CacheManager::ParseUrl(), CacheManager::cachemgrStateData::passwd, HttpHeader::putAuth(), StoreEntry::replaceHttpReply(), CacheManagerAction::run(), HttpReply::setHeaders(), squid_curtime, CacheManager::StateFree(), ErrorState::url, StoreEntry::url(), CacheManager::cachemgrStateData::user_name, and xstrdup().

Referenced by FwdState::fwdStart().