Mgr::StoreIoAction Class Reference

implement aggregated 'store_io' action More...

#include <StoreIoAction.h>

Inheritance diagram for Mgr::StoreIoAction:

Collaboration diagram for Mgr::StoreIoAction:

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

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

Detailed Description

Definition at line 34 of file StoreIoAction.h.

Member Typedef Documentation

Pointer

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

inherited

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

StoreIoAction()

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

protected

Definition at line 41 of file StoreIoAction.cc.

References debugs, and HERE().

Member Function Documentation

add()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 48 of file StoreIoAction.cc.

References action(), 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.

atomic()

bool Mgr::Action::atomic ( ) const

inherited

Definition at line 43 of file Action.cc.

collect()

void Mgr::StoreIoAction::collect ( )

protectedvirtual

Reimplemented from Mgr::Action.

Definition at line 55 of file StoreIoAction.cc.

References StoreIoStats::calls, StoreIoStats::create, StoreIoStats::create_fail, StoreIoStats::select_fail, store_io_stats, and StoreIoStats::success.

command()

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

inherited

Definition at line 36 of file Action.cc.

References Must, and NULL.

contentType()

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

inlinevirtualinherited

Definition at line 73 of file Action.h.

Create()

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

static

Definition at line 36 of file StoreIoAction.cc.

Referenced by storeRegisterWithCacheManager().

createStoreEntry()

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

dump()

void Mgr::StoreIoAction::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 64 of file StoreIoAction.cc.

References debugs, HERE(), Must, NULL, and storeAppendPrintf().

fillEntry()

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

name()

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

inherited

Definition at line 49 of file Action.cc.

pack()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 76 of file StoreIoAction.cc.

References 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 debugs, _request::fd, HERE(), and request().

run()

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

inherited

Definition at line 91 of file Action.cc.

References debugs, and HERE().

sendResponse()

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

inherited

Definition at line 82 of file Action.cc.

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

unpack()

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

virtual

Reimplemented from Mgr::Action.

Definition at line 83 of file StoreIoAction.cc.

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

Member Data Documentation

cmd

const CommandPointer Mgr::Action::cmd

privateinherited

Definition at line 86 of file Action.h.

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

data

StoreIoActionData Mgr::StoreIoAction::data

private

Definition at line 52 of file StoreIoAction.h.

---

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

• src/mgr/StoreIoAction.h
• src/mgr/StoreIoAction.cc