implement aggregated 'diskd' action More...

#include <DiskdAction.h>

Inheritance diagram for DiskdAction:

Collaboration diagram for DiskdAction:

Public Types
typedef RefCount< Action >	Pointer

Public Member Functions
void	add (const Mgr::Action &action) override
	incrementally merge in remote information (of the same action type)

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

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

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	respond (const Request &request)
	respond to Coordinator request; default is to collect and sendResponse

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

virtual bool	aggregatable () const

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 Mgr::CommandPointer &aCmd)

Protected Member Functions
	DiskdAction (const Mgr::CommandPointer &aCmd)

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

void	dump (StoreEntry *entry) override

Private Attributes
DiskdActionData	data

const CommandPointer	cmd
	the command that caused this action

Detailed Description

Definition at line 53 of file DiskdAction.h.

Member Typedef Documentation

◆ Pointer

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

inherited

Definition at line 28 of file Action.h.

Constructor & Destructor Documentation

◆ DiskdAction()

DiskdAction::DiskdAction ( const Mgr::CommandPointer & aCmd )

protected

Definition at line 65 of file DiskdAction.cc.

References debugs, and MYNAME.

Member Function Documentation

◆ add()

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

overridevirtual

Reimplemented from Mgr::Action.

Definition at line 72 of file DiskdAction.cc.

References data, debugs, and MYNAME.

◆ 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 Mgr::FunAction, and Ssl::CertificateStorageAction.

Definition at line 65 of file Action.h.

◆ atomic()

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 44 of file Action.cc.

◆ collect()

void DiskdAction::collect ( )

overrideprotectedvirtual

Reimplemented from Mgr::Action.

Definition at line 79 of file DiskdAction.cc.

References DiskdActionData::block_queue_len, diskd_stats_t::block_queue_len, diskd_stats_t::close, DiskdActionData::close_fail, DiskdActionData::close_ops, DiskdActionData::close_success, diskd_stats_t::create, DiskdActionData::create_fail, DiskdActionData::create_ops, DiskdActionData::create_success, data, diskd_stats, diskd_stats_t::fail, DiskdActionData::max_away, diskd_stats_t::max_away, DiskdActionData::max_shmuse, diskd_stats_t::max_shmuse, diskd_stats_t::open, DiskdActionData::open_fail, DiskdActionData::open_fail_queue_len, diskd_stats_t::open_fail_queue_len, DiskdActionData::open_ops, DiskdActionData::open_success, diskd_stats_t::ops, diskd_stats_t::read, DiskdActionData::read_fail, DiskdActionData::read_ops, DiskdActionData::read_success, DiskdActionData::recv_count, diskd_stats_t::recv_count, DiskdActionData::sent_count, diskd_stats_t::sent_count, diskd_stats_t::success, diskd_stats_t::unlink, DiskdActionData::unlink_fail, DiskdActionData::unlink_ops, DiskdActionData::unlink_success, diskd_stats_t::write, DiskdActionData::write_fail, DiskdActionData::write_ops, and DiskdActionData::write_success.

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

DiskdAction::Pointer DiskdAction::Create ( const Mgr::CommandPointer & aCmd )

static

Definition at line 60 of file DiskdAction.cc.

Referenced by DiskDaemonDiskIOModule::registerWithCacheManager().

◆ 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 DiskdAction::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 115 of file DiskdAction.cc.

References DiskdActionData::block_queue_len, DiskdActionData::close_fail, DiskdActionData::close_ops, DiskdActionData::close_success, DiskdActionData::create_fail, DiskdActionData::create_ops, DiskdActionData::create_success, data, debugs, DiskdActionData::max_away, DiskdActionData::max_shmuse, Must, MYNAME, DiskdActionData::open_fail, DiskdActionData::open_fail_queue_len, DiskdActionData::open_ops, DiskdActionData::open_success, DiskdActionData::read_fail, DiskdActionData::read_ops, DiskdActionData::read_success, DiskdActionData::recv_count, DiskdActionData::sent_count, storeAppendPrintf(), DiskdActionData::unlink_fail, DiskdActionData::unlink_ops, DiskdActionData::unlink_success, DiskdActionData::write_fail, DiskdActionData::write_ops, and DiskdActionData::write_success.

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

void DiskdAction::pack ( Ipc::TypedMsgHdr & ) const

overridevirtual

Reimplemented from Mgr::Action.

Definition at line 141 of file DiskdAction.cc.

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

◆ respond()

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

virtualinherited

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

Definition at line 88 of file Action.cc.

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

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

void DiskdAction::unpack ( const Ipc::TypedMsgHdr & )

overridevirtual

Reimplemented from Mgr::Action.

Definition at line 148 of file DiskdAction.cc.

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

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

◆ data

DiskdActionData DiskdAction::data

private

Definition at line 71 of file DiskdAction.h.

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

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

squid/src/DiskIO/DiskDaemon/DiskdAction.h
squid/src/DiskIO/DiskDaemon/DiskdAction.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ DiskdAction()

Member Function Documentation

◆ add()

◆ aggregatable()

◆ atomic()

◆ collect()

◆ command()

◆ contentType()

◆ Create()

◆ createStoreEntry()

◆ dump()

◆ fillEntry()

◆ format()

◆ name()

◆ pack()

◆ respond()

◆ run()

◆ sendResponse()

◆ unpack()

Member Data Documentation

◆ cmd

◆ data