returns available Cache Manager actions and their access requirements More...

#include <BasicActions.h>

Inheritance diagram for Mgr::MenuAction:
Collaboration diagram for Mgr::MenuAction:

Public Types

typedef RefCount< ActionPointer
 

Public Member Functions

virtual void dump (StoreEntry *entry)
 
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
 

Static Public Member Functions

static Pointer Create (const CommandPointer &cmd)
 

Protected Member Functions

 MenuAction (const CommandPointer &cmd)
 
virtual void collect ()
 calculate and keep local action-specific information More...
 

Detailed Description

Definition at line 37 of file BasicActions.h.

Member Typedef Documentation

◆ Pointer

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

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

◆ MenuAction()

Mgr::MenuAction::MenuAction ( const CommandPointer cmd)
protected

Definition at line 45 of file BasicActions.cc.

References debugs, and HERE().

Member Function Documentation

◆ add()

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

◆ 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.

References Mgr::Action::atomic(), Mgr::Action::command(), Mgr::Action::createStoreEntry(), and Mgr::Action::name().

◆ atomic()

bool Mgr::Action::atomic ( ) const
inherited

◆ collect()

virtual void Mgr::Action::collect ( )
inlineprotectedvirtualinherited

◆ command()

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

◆ contentType()

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

Definition at line 73 of file Action.h.

Referenced by Mgr::Action::fillEntry().

◆ Create()

Mgr::MenuAction::Pointer Mgr::MenuAction::Create ( const CommandPointer cmd)
static

Definition at line 40 of file BasicActions.cc.

Referenced by Mgr::RegisterBasics().

◆ createStoreEntry()

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

◆ dump()

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

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 51 of file BasicActions.cc.

References a, CacheManager::ActionProtection(), debugs, CacheManager::GetInstance(), HERE(), Iterator, CacheManager::menu(), Must, NULL, and storeAppendPrintf().

◆ fillEntry()

◆ name()

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

Definition at line 49 of file Action.cc.

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

Referenced by Mgr::Action::aggregatable().

◆ pack()

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

◆ respond()

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

◆ run()

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

Definition at line 91 of file Action.cc.

References Mgr::Action::collect(), debugs, Mgr::Action::fillEntry(), and HERE().

◆ sendResponse()

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

◆ unpack()

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

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors