#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

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

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

Definition at line 25 of file Action.cc.

References cmd, Must, and NULL.

Mgr::Action::~Action ( )
virtual

Definition at line 31 of file Action.cc.

Mgr::Action::Action ( const Action )
private

Member Function Documentation

void Mgr::Action::add ( const Action action)
virtual
virtual bool Mgr::Action::aggregatable ( ) const
inlinevirtual

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.

bool Mgr::Action::atomic ( ) const

Definition at line 43 of file Action.cc.

virtual void Mgr::Action::collect ( )
inlineprotectedvirtual
const Mgr::Command & Mgr::Action::command ( ) const

Definition at line 36 of file Action.cc.

References Must, and NULL.

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

Definition at line 73 of file Action.h.

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

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

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

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.

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

Definition at line 49 of file Action.cc.

Action& Mgr::Action::operator= ( const Action )
private
virtual void Mgr::Action::pack ( Ipc::TypedMsgHdr ) const
inlinevirtual
void Mgr::Action::respond ( const Request request)
virtual

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

Definition at line 68 of file Action.cc.

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

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

Definition at line 91 of file Action.cc.

References debugs, and HERE().

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

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

Member Data Documentation

const CommandPointer Mgr::Action::cmd
private

Definition at line 86 of file Action.h.

Referenced by Action().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors