Action.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* DEBUG: section 16    Cache Manager API */
 
#ifndef SQUID_SRC_MGR_ACTION_H
#define SQUID_SRC_MGR_ACTION_H
 
#include "ipc/forward.h"
#include "mgr/ActionFeatures.h"
#include "mgr/forward.h"
 
class StoreEntry;
 
namespace Mgr
{
 
class Action: public RefCountable
{
public:
    typedef RefCount<Action> Pointer;
 
public:
    Action(const CommandPointer &aCmd);
    ~Action() override;
 
    /* for local Cache Manager use */
 
    void run(StoreEntry *entry, bool writeHttpHeader);
 
    void fillEntry(StoreEntry *entry, bool writeHttpHeader);
 
    /* for global Coordinator use */
 
    virtual void add(const Action &action);
 
    /* global-local communication */
 
    virtual void respond(const Request &request);
 
    virtual void pack(Ipc::TypedMsgHdr &) const {}
 
    virtual void unpack(const Ipc::TypedMsgHdr &) {}
 
    void sendResponse(Ipc::RequestId);
 
    /* Action properties */
 
    virtual bool aggregatable() const { return true; } // most kid classes are
 
    virtual Format format() const;
 
    bool atomic() const; 
    const char *name() const; 
    const Command &command() const; 
 
    StoreEntry *createStoreEntry() const; 
 
    const char *contentType() const;
 
protected:
    virtual void collect() {}
 
    virtual void dump(StoreEntry *) {}
 
private:
    const CommandPointer cmd; 
 
private:
    Action(const Action &); // not implemented
    Action &operator= (const Action &); // not implemented
};
 
void OpenKidSection(StoreEntry *, Format);
 
void CloseKidSection(StoreEntry *, Format);
 
} // namespace Mgr
 
#endif /* SQUID_SRC_MGR_ACTION_H */