#include <Action.h>

Inheritance diagram for Mgr::Action:
Collaboration diagram for Mgr::Action:

Public Types

typedef RefCount< ActionPointer

Public Member Functions

 Action (const CommandPointer &aCmd)
virtual ~Action ()
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 (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 Commandcommand () const
 the cause of this action More...
StoreEntrycreateStoreEntry () const
 creates store entry from params More...
virtual const char * contentType () const

Protected Member Functions

virtual void collect ()
 calculate and keep local action-specific information More...
virtual void dump (StoreEntry *)

Private Member Functions

 Action (const Action &)
Actionoperator= (const Action &)

Private Attributes

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

Detailed Description

Base API for organizing the processing of a compiled cache manager command. Not a job because all methods are synchronous (but they may start jobs).

Definition at line 24 of file Action.h.

Member Typedef Documentation

◆ Pointer

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Mgr::Action::Action ( const CommandPointer aCmd)

Definition at line 25 of file Action.cc.

References cmd, Must, and NULL.

◆ ~Action()

Mgr::Action::~Action ( )

Definition at line 31 of file Action.cc.

◆ Action() [2/2]

Mgr::Action::Action ( const Action )

Member Function Documentation

◆ add()

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

◆ aggregatable()

virtual bool Mgr::Action::aggregatable ( ) const

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 atomic(), command(), createStoreEntry(), and name().

◆ atomic()

bool Mgr::Action::atomic ( ) const

Definition at line 43 of file Action.cc.

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

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

◆ collect()

virtual void Mgr::Action::collect ( )

◆ command()

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

Definition at line 36 of file Action.cc.

References cmd, Must, and NULL.

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

◆ contentType()

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

Definition at line 73 of file Action.h.

Referenced by fillEntry().

◆ createStoreEntry()

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

Content-Type: header value for this report

Definition at line 55 of file Action.cc.

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

Referenced by aggregatable().

◆ dump()

virtual void Mgr::Action::dump ( StoreEntry )

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 in Mgr::IntervalAction, Mgr::InfoAction, Mgr::CountersAction, Mgr::OfflineToggleAction, Mgr::RotateAction, DiskdAction, Mgr::ReconfigureAction, Mgr::ServiceTimesAction, Mgr::ShutdownAction, Mgr::IoAction, Mgr::StoreIoAction, Ssl::CertificateStorageAction, Mgr::MenuAction, Mgr::FunAction, Mgr::IndexAction, and SBufStatsAction.

Definition at line 83 of file Action.h.

Referenced by fillEntry().

◆ fillEntry()

◆ name()

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

Definition at line 49 of file Action.cc.

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

Referenced by aggregatable().

◆ operator=()

Action& Mgr::Action::operator= ( const Action )

◆ pack()

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

◆ respond()

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

◆ run()

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

Definition at line 91 of file Action.cc.

References collect(), debugs, fillEntry(), and HERE().

◆ sendResponse()

void Mgr::Action::sendResponse ( unsigned int  requestId)

Definition at line 82 of file Action.cc.

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

Referenced by respond(), and unpack().

◆ unpack()

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

Member Data Documentation

◆ cmd

const CommandPointer Mgr::Action::cmd

Definition at line 86 of file Action.h.

Referenced by Action(), and command().

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






Web Site Translations