implement aggregated 'io' action More...

#include <IoAction.h>

Inheritance diagram for Mgr::IoAction:
Collaboration diagram for Mgr::IoAction:

Public Types

typedef RefCount< ActionPointer
 

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

 IoAction (const CommandPointer &cmd)
 
virtual void collect ()
 calculate and keep local action-specific information More...
 
virtual void dump (StoreEntry *entry)
 

Private Attributes

IoActionData data
 

Detailed Description

Definition at line 37 of file IoAction.h.

Member Typedef Documentation

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

Definition at line 27 of file Action.h.

Constructor & Destructor Documentation

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

Definition at line 51 of file IoAction.cc.

References debugs, and HERE().

Member Function Documentation

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

Reimplemented from Mgr::Action.

Definition at line 58 of file IoAction.cc.

References action(), data, debugs, and HERE().

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.

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

Definition at line 43 of file Action.cc.

void Mgr::IoAction::collect ( )
protectedvirtual

Reimplemented from Mgr::Action.

Definition at line 65 of file IoAction.cc.

References data, and GetIoStats().

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

Definition at line 36 of file Action.cc.

References Must, and NULL.

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

Definition at line 73 of file Action.h.

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

Definition at line 46 of file IoAction.cc.

Referenced by statRegisterWithCacheManager().

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

void Mgr::IoAction::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 71 of file IoAction.cc.

References data, debugs, DumpIoStats(), HERE(), Must, and NULL.

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

Definition at line 49 of file Action.cc.

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

Reimplemented from Mgr::Action.

Definition at line 79 of file IoAction.cc.

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

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

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 
)
inherited

Definition at line 91 of file Action.cc.

References debugs, and HERE().

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

Definition at line 82 of file Action.cc.

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

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

Reimplemented from Mgr::Action.

Definition at line 86 of file IoAction.cc.

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

Member Data Documentation

IoActionData Mgr::IoAction::data
private

Definition at line 55 of file IoAction.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors