BasicActions.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 16 Cache Manager API */
10 
11 #ifndef SQUID_SRC_MGR_BASICACTIONS_H
12 #define SQUID_SRC_MGR_BASICACTIONS_H
13 
14 #include "mgr/Action.h"
15 
16 /* a collection of simple, mostly stateless actions */
17 
18 namespace Mgr
19 {
20 
25 class IndexAction: public Action
26 {
27 public:
28  static Pointer Create(const CommandPointer &cmd);
29  /* Action API */
30  void dump(StoreEntry *entry) override;
31 
32 protected:
34 };
35 
37 class MenuAction: public Action
38 {
39 public:
40  static Pointer Create(const CommandPointer &cmd);
41  /* Action API */
42  void dump(StoreEntry *entry) override;
43 
44 protected:
46 };
47 
49 class ShutdownAction: public Action
50 {
51 public:
52  static Pointer Create(const CommandPointer &cmd);
53  /* Action API */
54  void dump(StoreEntry *entry) override;
55 
56 protected:
58 };
59 
62 {
63 public:
64  static Pointer Create(const CommandPointer &cmd);
65  /* Action API */
66  void dump(StoreEntry *entry) override;
67 
68 protected:
70 };
71 
73 class RotateAction: public Action
74 {
75 public:
76  static Pointer Create(const CommandPointer &cmd);
77  /* Action API */
78  void dump(StoreEntry *entry) override;
79 
80 protected:
82 };
83 
86 {
87 public:
88  static Pointer Create(const CommandPointer &cmd);
89  /* Action API */
90  void dump(StoreEntry *entry) override;
91 
92 protected:
94 };
95 
97 void RegisterBasics();
98 
99 } // namespace Mgr
100 
101 #endif /* SQUID_SRC_MGR_BASICACTIONS_H */
102 
returns available Cache Manager actions and their access requirements
Definition: BasicActions.h:37
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:23
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:40
void dump(StoreEntry *entry) override
const CommandPointer cmd
the command that caused this action
Definition: Action.h:90
shuts Squid down
Definition: BasicActions.h:49
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:67
changes offline mode
Definition: BasicActions.h:85
ShutdownAction(const CommandPointer &cmd)
Definition: BasicActions.cc:72
void RegisterBasics()
Registers profiles for the actions above; TODO: move elsewhere?
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:51
reconfigures Squid
Definition: BasicActions.h:61
void dump(StoreEntry *entry) override
OfflineToggleAction(const CommandPointer &cmd)
static Pointer Create(const CommandPointer &cmd)
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:97
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:85
starts log rotation
Definition: BasicActions.h:73
IndexAction(const CommandPointer &cmd)
Definition: BasicActions.cc:28
RotateAction(const CommandPointer &cmd)
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:78
static Pointer Create(const CommandPointer &cmd)
ReconfigureAction(const CommandPointer &cmd)
Definition: BasicActions.cc:90
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:34
MenuAction(const CommandPointer &cmd)
Definition: BasicActions.cc:45
Cache Manager API.
Definition: Action.h:20

 

Introduction

Documentation

Support

Miscellaneous