Mgr::ServiceTimesAction Class Reference

implement aggregated 'service_times' action More...

#include <ServiceTimesAction.h>

Inheritance diagram for Mgr::ServiceTimesAction:

Collaboration diagram for Mgr::ServiceTimesAction:

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
	ServiceTimesAction (const CommandPointer &cmd)
virtual void	collect ()
	calculate and keep local action-specific information More...
virtual void	dump (StoreEntry *entry)

Private Attributes
ServiceTimesActionData	data

Detailed Description

Definition at line 48 of file ServiceTimesAction.h.

Member Typedef Documentation

Pointer

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

inherited

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

ServiceTimesAction()

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

protected

Definition at line 63 of file ServiceTimesAction.cc.

References debugs, and HERE().

Member Function Documentation

add()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 70 of file ServiceTimesAction.cc.

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

aggregatable()

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.

References Mgr::Action::atomic(), Mgr::Action::command(), Mgr::Action::createStoreEntry(), and Mgr::Action::name().

atomic()

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 43 of file Action.cc.

References Mgr::Action::command(), and Mgr::Command::profile.

Referenced by Mgr::Action::aggregatable(), Mgr::FunAction::dump(), and Mgr::Action::fillEntry().

collect()

void Mgr::ServiceTimesAction::collect ( )

protectedvirtual

Reimplemented from Mgr::Action.

Definition at line 77 of file ServiceTimesAction.cc.

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

command()

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

inherited

Definition at line 36 of file Action.cc.

References Mgr::Action::cmd, Must, and NULL.

Referenced by Mgr::Action::aggregatable(), Mgr::Action::atomic(), Mgr::Action::createStoreEntry(), Mgr::Action::fillEntry(), and Mgr::Action::name().

contentType()

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

inlinevirtualinherited

Definition at line 73 of file Action.h.

Referenced by Mgr::Action::fillEntry().

Create()

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

static

Definition at line 58 of file ServiceTimesAction.cc.

Referenced by statRegisterWithCacheManager().

createStoreEntry()

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

inherited

Content-Type: header value for this report

Definition at line 55 of file Action.cc.

References Mgr::Action::command(), Mgr::ActionParams::httpFlags, Mgr::ActionParams::httpMethod, Mgr::ActionParams::httpUri, Mgr::Command::params, storeCreateEntry(), and String::termedBuf().

Referenced by Mgr::Action::aggregatable().

dump()

void Mgr::ServiceTimesAction::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 84 of file ServiceTimesAction.cc.

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

fillEntry()

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

inherited

Definition at line 99 of file Action.cc.

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

Referenced by Mgr::Action::run().

name()

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

inherited

Definition at line 49 of file Action.cc.

References Mgr::Action::command(), and Mgr::Command::profile.

Referenced by Mgr::Action::aggregatable().

pack()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 92 of file ServiceTimesAction.cc.

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

respond()

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::Action::collect(), Mgr::Request::conn, debugs, Comm::Connection::fd, HERE(), Ipc::Request::requestId, and Mgr::Action::sendResponse().

run()

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

inherited

Definition at line 91 of file Action.cc.

References Mgr::Action::collect(), debugs, Mgr::Action::fillEntry(), and HERE().

sendResponse()

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

Referenced by Mgr::Action::respond(), and Mgr::Action::unpack().

unpack()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 99 of file ServiceTimesAction.cc.

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

Member Data Documentation

data

ServiceTimesActionData Mgr::ServiceTimesAction::data

private

Definition at line 66 of file ServiceTimesAction.h.

Referenced by add(), collect(), dump(), pack(), and unpack().

---

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

• src/mgr/ServiceTimesAction.h
• src/mgr/ServiceTimesAction.cc