Mgr::IndexAction Class Reference

#include <BasicActions.h>

Inheritance diagram for Mgr::IndexAction:

Collaboration diagram for Mgr::IndexAction:

Public Types
typedef RefCount< Action >	Pointer

Public Member Functions
void	dump (StoreEntry *entry) override
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	add (const Action &action)
	incrementally merge in remote information (of the same action type) More...
virtual void	respond (const Request &request)
	respond to Coordinator request; default is to collect and sendResponse More...
virtual void	pack (Ipc::TypedMsgHdr &) const
	pack collected action info into a message to be sent to Coordinator More...
virtual void	unpack (const Ipc::TypedMsgHdr &)
	unpack action info from the message received by Coordinator More...
void	sendResponse (Ipc::RequestId)
	notify Coordinator that this action is done with local processing More...
virtual bool	aggregatable () const
virtual Format	format () const
	action report syntax More...
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...
const char *	contentType () const
	HTTP Content-Type header value for this Action report. More...

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

Protected Member Functions
	IndexAction (const CommandPointer &cmd)
virtual void	collect ()
	calculate and keep local action-specific information More...

Private Attributes
const CommandPointer	cmd
	the command that caused this action More...

Detailed Description

A dummy action placeholder for the no-action requests a templated Cache Manager index ('home') page. Display output is produced directly by the receiving worker without invoking the co-ordinator or action Job.

Definition at line 25 of file BasicActions.h.

Member Typedef Documentation

Pointer

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

inherited

Definition at line 28 of file Action.h.

Constructor & Destructor Documentation

IndexAction()

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

protected

Definition at line 28 of file BasicActions.cc.

References debugs, and MYNAME.

Referenced by Create().

Member Function Documentation

add()

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

virtualinherited

Reimplemented in DiskdAction, SBufStatsAction, Mgr::IntervalAction, Mgr::InfoAction, Mgr::CountersAction, Mgr::ServiceTimesAction, Mgr::IoAction, and Mgr::StoreIoAction.

Definition at line 82 of file Action.cc.

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 65 of file Action.h.

atomic()

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 43 of file Action.cc.

collect()

virtual void Mgr::Action::collect ( )

inlineprotectedvirtualinherited

Reimplemented in Mgr::IntervalAction, Mgr::InfoAction, Mgr::CountersAction, DiskdAction, Mgr::ServiceTimesAction, Mgr::IoAction, Mgr::StoreIoAction, and SBufStatsAction.

Definition at line 81 of file Action.h.

command()

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

inherited

Definition at line 36 of file Action.cc.

References Must.

contentType()

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

inherited

Definition at line 61 of file Action.cc.

References assert, Mgr::informal, and Mgr::yaml.

Create()

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

static

Definition at line 23 of file BasicActions.cc.

References Mgr::Action::cmd, and IndexAction().

Referenced by Mgr::RegisterBasics().

createStoreEntry()

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

inherited

Definition at line 74 of file Action.cc.

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

dump()

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

overridevirtual

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 34 of file BasicActions.cc.

References debugs, and MYNAME.

fillEntry()

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

inherited

Definition at line 118 of file Action.cc.

References StoreEntry::buffer(), StoreEntry::complete(), debugs, StoreEntry::flush(), MYNAME, CacheManager::PutCommonResponseHeaders(), StoreEntry::replaceHttpReply(), Http::scOkay, HttpReply::setHeaders(), and squid_curtime.

format()

Mgr::Format Mgr::Action::format ( ) const

virtualinherited

Definition at line 49 of file Action.cc.

name()

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

inherited

Definition at line 55 of file Action.cc.

pack()

virtual void Mgr::Action::pack ( Ipc::TypedMsgHdr &  ) const

inlinevirtualinherited

Reimplemented in Mgr::IntervalAction, Mgr::InfoAction, Mgr::CountersAction, Mgr::ServiceTimesAction, Mgr::IoAction, Mgr::StoreIoAction, SBufStatsAction, and DiskdAction.

Definition at line 53 of file Action.h.

respond()

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

virtualinherited

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

Definition at line 87 of file Action.cc.

References Mgr::Request::conn, debugs, Comm::Connection::fd, MYNAME, and Ipc::Request::requestId.

run()

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

inherited

Definition at line 110 of file Action.cc.

References debugs, and MYNAME.

sendResponse()

void Mgr::Action::sendResponse ( Ipc::RequestId  requestId )

inherited

Definition at line 101 of file Action.cc.

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

unpack()

virtual void Mgr::Action::unpack ( const Ipc::TypedMsgHdr &  )

inlinevirtualinherited

Reimplemented in Mgr::IntervalAction, Mgr::InfoAction, Mgr::CountersAction, Mgr::ServiceTimesAction, Mgr::IoAction, Mgr::StoreIoAction, SBufStatsAction, and DiskdAction.

Definition at line 56 of file Action.h.

Member Data Documentation

cmd

const CommandPointer Mgr::Action::cmd

privateinherited

Definition at line 90 of file Action.h.

Referenced by Mgr::Action::Action(), SBufStatsAction::Create(), and Create().

---

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

• src/mgr/BasicActions.h
• src/mgr/BasicActions.cc