Squid Web Cache master
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
Mgr::IoAction Class Reference

implement aggregated 'io' action More...

#include <IoAction.h>

Inheritance diagram for Mgr::IoAction:
[legend]
Collaboration diagram for Mgr::IoAction:
[legend]

Public Types

typedef RefCount< Action > Pointer
 

Public Member Functions

void add (const Action &action) override
 incrementally merge in remote information (of the same action type)
 
void pack (Ipc::TypedMsgHdr &msg) const override
 pack collected action info into a message to be sent to Coordinator
 
void unpack (const Ipc::TypedMsgHdr &msg) override
 unpack action info from the message received by Coordinator
 
void run (StoreEntry *entry, bool writeHttpHeader)
 collect + fillEntry: collect local information and fill the store entry
 
void fillEntry (StoreEntry *entry, bool writeHttpHeader)
 prepare store entry, dump info, close store entry (if possible)
 
virtual void respond (const Request &request)
 respond to Coordinator request; default is to collect and sendResponse
 
void sendResponse (Ipc::RequestId)
 notify Coordinator that this action is done with local processing
 
virtual bool aggregatable () const
 
virtual Format format () const
 action report syntax
 
bool atomic () const
 dump() call writes everything before returning
 
const char * name () const
 label as seen in the cache manager menu
 
const Command & command () const
 the cause of this action
 
StoreEntry * createStoreEntry () const
 creates store entry from params
 
const char * contentType () const
 HTTP Content-Type header value for this Action report.
 

Static Public Member Functions

static Pointer Create (const CommandPointer &cmd)
 

Protected Member Functions

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

Private Attributes

IoActionData data
 
const CommandPointer cmd
 the command that caused this action
 

Detailed Description

Definition at line 35 of file IoAction.h.

Member Typedef Documentation

◆ Pointer

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

Definition at line 28 of file Action.h.

Constructor & Destructor Documentation

◆ IoAction()

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

Definition at line 48 of file IoAction.cc.

References debugs, and MYNAME.

Member Function Documentation

◆ add()

void Mgr::IoAction::add ( const Action &  action)
overridevirtual

Reimplemented from Mgr::Action.

Definition at line 55 of file IoAction.cc.

References debugs, and MYNAME.

◆ 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 Mgr::FunAction, and Ssl::CertificateStorageAction.

Definition at line 65 of file Action.h.

◆ atomic()

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

Definition at line 44 of file Action.cc.

◆ collect()

void Mgr::IoAction::collect ( )
overrideprotectedvirtual

Reimplemented from Mgr::Action.

Definition at line 62 of file IoAction.cc.

References GetIoStats().

◆ command()

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

Definition at line 37 of file Action.cc.

References Must.

◆ contentType()

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

Definition at line 62 of file Action.cc.

References assert, Mgr::informal, and Mgr::yaml.

◆ Create()

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

Definition at line 43 of file IoAction.cc.

Referenced by statRegisterWithCacheManager().

◆ createStoreEntry()

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

Definition at line 75 of file Action.cc.

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

◆ dump()

void Mgr::IoAction::dump ( StoreEntry *  )
overrideprotectedvirtual

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 68 of file IoAction.cc.

References debugs, DumpIoStats(), Must, and MYNAME.

◆ fillEntry()

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

Definition at line 119 of file Action.cc.

References StoreEntry::buffer(), StoreEntry::complete(), debugs, StoreEntry::flush(), MYNAME, CacheManager::PutCommonResponseHeaders(), StoreEntry::replaceHttpReply(), Http::scOkay, HttpReply::setHeaders(), and squid_curtime.

◆ format()

Mgr::Format Mgr::Action::format ( ) const
virtualinherited

Definition at line 50 of file Action.cc.

◆ name()

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

Definition at line 56 of file Action.cc.

◆ pack()

void Mgr::IoAction::pack ( Ipc::TypedMsgHdr &  ) const
overridevirtual

Reimplemented from Mgr::Action.

Definition at line 76 of file IoAction.cc.

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

◆ respond()

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

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

Definition at line 88 of file Action.cc.

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

◆ run()

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

Definition at line 111 of file Action.cc.

References debugs, and MYNAME.

◆ sendResponse()

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

Definition at line 102 of file Action.cc.

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

◆ unpack()

void Mgr::IoAction::unpack ( const Ipc::TypedMsgHdr &  )
overridevirtual

Reimplemented from Mgr::Action.

Definition at line 83 of file IoAction.cc.

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

Member Data Documentation

◆ cmd

const CommandPointer Mgr::Action::cmd
privateinherited

Definition at line 90 of file Action.h.

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

◆ data

IoActionData Mgr::IoAction::data
private

Definition at line 53 of file IoAction.h.

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