Mgr::CountersAction Class Reference

implement aggregated 'counters' action

#include <CountersAction.h>

Inheritance diagram for Mgr::CountersAction:

Collaboration diagram for Mgr::CountersAction:

Public Types
typedef RefCount< Action >	Pointer

Public Member Functions
virtual void	add (const Action &action)
	incrementally merge in remote information (of the same action type) More...
virtual void	pack (Ipc::TypedMsgHdr &msg) const
	pack collected action info into a message to be sent to Coordinator More...
virtual void	unpack (const Ipc::TypedMsgHdr &msg)
	unpack action info from the message received by Coordinator More...
void	run (StoreEntry *entry, bool writeHttpHeader)
	collect + fillEntry: collect local information and fill the store entry More...
void	fillEntry (StoreEntry *entry, bool writeHttpHeader)
	prepare store entry, dump info, close store entry (if possible) More...
virtual void	respond (const Request &request)
	respond to Coordinator request; default is to collect and sendResponse More...
void	sendResponse (unsigned int requestId)
	notify Coordinator that this action is done with local processing More...
virtual bool	aggregatable () const
bool	atomic () const
	dump() call writes everything before returning More...
const char *	name () const
	label as seen in the cache manager menu More...
const Command &	command () const
	the cause of this action More...
StoreEntry *	createStoreEntry () const
	creates store entry from params More...
virtual const char *	contentType () const

Static Public Member Functions
static Pointer	Create (const CommandPointer &cmd)

Protected Member Functions
	CountersAction (const CommandPointer &cmd)
virtual void	collect ()
	calculate and keep local action-specific information More...
virtual void	dump (StoreEntry *entry)

Private Attributes
CountersActionData	data

Detailed Description

Definition at line 86 of file CountersAction.h.

Member Typedef Documentation

typedef RefCount<Action> Mgr::Action::Pointer

inherited

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

Mgr::CountersAction::CountersAction ( const CommandPointer &  cmd )

protected

Definition at line 98 of file CountersAction.cc.

References debugs, and HERE().

Member Function Documentation

void Mgr::CountersAction::add ( const Action &  action )

virtual

Reimplemented from Mgr::Action.

Definition at line 105 of file CountersAction.cc.

References action(), data, debugs, and HERE().

virtual bool Mgr::Action::aggregatable ( ) const

inlinevirtualinherited

whether at least some local kid info can be combined and, hence, the combined data should be written at the end of the coordinated response

Reimplemented in Ssl::CertificateStorageAction, and Mgr::FunAction.

Definition at line 64 of file Action.h.

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 43 of file Action.cc.

void Mgr::CountersAction::collect ( )

protectedvirtual

Reimplemented from Mgr::Action.

Definition at line 112 of file CountersAction.cc.

References data, debugs, GetCountersStats(), and HERE().

const Mgr::Command & Mgr::Action::command ( ) const

inherited

Definition at line 36 of file Action.cc.

References Must, and NULL.

virtual const char* Mgr::Action::contentType ( ) const

inlinevirtualinherited

Definition at line 73 of file Action.h.

Mgr::CountersAction::Pointer Mgr::CountersAction::Create ( const CommandPointer &  cmd )

static

Definition at line 93 of file CountersAction.cc.

Referenced by statRegisterWithCacheManager().

StoreEntry * Mgr::Action::createStoreEntry ( ) const

inherited

Content-Type: header value for this report

Definition at line 55 of file Action.cc.

References Mgr::ActionParams::httpFlags, Mgr::ActionParams::httpMethod, Mgr::ActionParams::httpUri, storeCreateEntry(), and String::termedBuf().

void Mgr::CountersAction::dump ( StoreEntry *  )

protectedvirtual

start writing action-specific info to Store entry; may collect info during dump, especially if collect() did nothing non-atomic() actions may continue writing asynchronously after returning

Reimplemented from Mgr::Action.

Definition at line 119 of file CountersAction.cc.

References data, debugs, DumpCountersStats(), HERE(), Must, and NULL.

void Mgr::Action::fillEntry ( StoreEntry *  entry, bool  writeHttpHeader  )

inherited

Definition at line 99 of file Action.cc.

References StoreEntry::buffer(), StoreEntry::complete(), debugs, StoreEntry::flush(), Http::Message::header, HERE(), Mgr::ActionParams::httpOrigin, NULL, HttpHeader::putExt(), StoreEntry::replaceHttpReply(), Http::scOkay, HttpReply::setHeaders(), String::size(), squid_curtime, and String::termedBuf().

const char * Mgr::Action::name ( ) const

inherited

Definition at line 49 of file Action.cc.

void Mgr::CountersAction::pack ( Ipc::TypedMsgHdr &  ) const

virtual

Reimplemented from Mgr::Action.

Definition at line 127 of file CountersAction.cc.

References data, Ipc::mtCacheMgrResponse, Ipc::TypedMsgHdr::putPod(), and Ipc::TypedMsgHdr::setType().

void Mgr::Action::respond ( const Request &  request )

virtualinherited

Reimplemented in Mgr::InfoAction, and Mgr::FunAction.

Definition at line 68 of file Action.cc.

References Mgr::Request::conn, debugs, Comm::Connection::fd, HERE(), and Ipc::Request::requestId.

void Mgr::Action::run ( StoreEntry *  entry, bool  writeHttpHeader  )

inherited

Definition at line 91 of file Action.cc.

References debugs, and HERE().

void Mgr::Action::sendResponse ( unsigned int  requestId )

inherited

Definition at line 82 of file Action.cc.

References Ipc::Port::CoordinatorAddr(), Mgr::Response::pack(), and Ipc::SendMessage().

void Mgr::CountersAction::unpack ( const Ipc::TypedMsgHdr &  )

virtual

Reimplemented from Mgr::Action.

Definition at line 134 of file CountersAction.cc.

References Ipc::TypedMsgHdr::checkType(), data, Ipc::TypedMsgHdr::getPod(), and Ipc::mtCacheMgrResponse.

Member Data Documentation

CountersActionData Mgr::CountersAction::data

private

Definition at line 104 of file CountersAction.h.

---

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

• src/mgr/CountersAction.h
• src/mgr/CountersAction.cc