#include <FunAction.h>

Inheritance diagram for Mgr::FunAction:

Collaboration diagram for Mgr::FunAction:

Public Types
typedef RefCount< Action >	Pointer

Public Member Functions
void	respond (const Request &request) override
	respond to Coordinator request; default is to collect and sendResponse

bool	aggregatable () const override

void	run (StoreEntry *entry, bool writeHttpHeader)
	collect + fillEntry: collect local information and fill the store entry

void	fillEntry (StoreEntry *entry, bool writeHttpHeader)
	prepare store entry, dump info, close store entry (if possible)

virtual void	add (const Action &action)
	incrementally merge in remote information (of the same action type)

virtual void	pack (Ipc::TypedMsgHdr &) const
	pack collected action info into a message to be sent to Coordinator

virtual void	unpack (const Ipc::TypedMsgHdr &)
	unpack action info from the message received by Coordinator

void	sendResponse (Ipc::RequestId)
	notify Coordinator that this action is done with local processing

virtual Format	format () const
	action report syntax

bool	atomic () const
	dump() call writes everything before returning

const char *	name () const
	label as seen in the cache manager menu

const Command &	command () const
	the cause of this action

StoreEntry *	createStoreEntry () const
	creates store entry from params

const char *	contentType () const
	HTTP Content-Type header value for this Action report.

Static Public Member Functions
static Pointer	Create (const CommandPointer &cmd, OBJH *aHandler)

Protected Member Functions
	FunAction (const CommandPointer &cmd, OBJH *aHandler)

void	dump (StoreEntry *entry) override

virtual void	collect ()
	calculate and keep local action-specific information

Private Attributes
OBJH *	handler
	legacy function that collects and dumps info

const CommandPointer	cmd
	the command that caused this action

Detailed Description

function-based cache manager Action; a wrapper for so called legacy actions that do everything using a single OBJH function

Definition at line 22 of file FunAction.h.

Member Typedef Documentation

◆ Pointer

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

inherited

Definition at line 28 of file Action.h.

Constructor & Destructor Documentation

◆ FunAction()

Mgr::FunAction::FunAction	(	const CommandPointer &	cmd,
		OBJH *	aHandler
	)

protected

Definition at line 30 of file FunAction.cc.

References debugs, handler, Must, and MYNAME.

Member Function Documentation

◆ add()

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

virtualinherited

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

Definition at line 83 of file Action.cc.

◆ aggregatable()

bool Mgr::FunAction::aggregatable ( ) const

inlineoverridevirtual

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 from Mgr::Action.

Definition at line 33 of file FunAction.h.

◆ atomic()

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 44 of file Action.cc.

◆ collect()

virtual void Mgr::Action::collect ( )

inlineprotectedvirtualinherited

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

Definition at line 81 of file Action.h.

◆ command()

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

inherited

Definition at line 37 of file Action.cc.

References Must.

◆ contentType()

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

inherited

Definition at line 62 of file Action.cc.

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

◆ Create()

Mgr::FunAction::Pointer Mgr::FunAction::Create	(	const CommandPointer &	cmd,
		OBJH *	aHandler
	)

static

Definition at line 25 of file FunAction.cc.

Referenced by Mgr::FunActionCreator::create().

◆ createStoreEntry()

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

inherited

Definition at line 75 of file Action.cc.

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

◆ dump()

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

overrideprotectedvirtual

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 48 of file FunAction.cc.

References Mgr::CloseKidSection(), debugs, Must, MYNAME, and Mgr::OpenKidSection().

◆ fillEntry()

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

inherited

Definition at line 119 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 50 of file Action.cc.

◆ name()

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

inherited

Definition at line 56 of file Action.cc.

◆ pack()

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

inlinevirtualinherited

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

Definition at line 53 of file Action.h.

◆ respond()

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

overridevirtual

Reimplemented from Mgr::Action.

Definition at line 38 of file FunAction.cc.

References Mgr::Request::conn, debugs, Ipc::fdnHttpSocket, Ipc::ImportFdIntoComm(), Comm::IsConnOpen(), Must, MYNAME, Ipc::Request::requestId, and AsyncJob::Start().

◆ run()

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

inherited

Definition at line 111 of file Action.cc.

References debugs, and MYNAME.

◆ sendResponse()

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

inherited

Definition at line 102 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 DiskdAction, Mgr::CountersAction, Mgr::InfoAction, Mgr::IntervalAction, Mgr::IoAction, Mgr::ServiceTimesAction, Mgr::StoreIoAction, and SBufStatsAction.

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(), Mgr::IndexAction::Create(), and SBufStatsAction::Create().

◆ handler

OBJH* Mgr::FunAction::handler

private

Definition at line 40 of file FunAction.h.

Referenced by FunAction().

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

squid/src/mgr/FunAction.h
squid/src/mgr/FunAction.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ FunAction()

Member Function Documentation

◆ add()

◆ aggregatable()

◆ atomic()

◆ collect()

◆ command()

◆ contentType()

◆ Create()

◆ createStoreEntry()

◆ dump()

◆ fillEntry()

◆ format()

◆ name()

◆ pack()

◆ respond()

◆ run()

◆ sendResponse()

◆ unpack()

Member Data Documentation

◆ cmd

◆ handler