stub_libmgr.cc
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#include "squid.h"
10#include "comm/Connection.h"
11
12#define STUB_API "lmgr/libmgr.la"
13#include "tests/STUB.h"
14
15#include "ipc/RequestId.h"
16
17// NP: used by Command.h instantiations
18#include "mgr/ActionProfile.h"
19
20// NP: used by Action.h instantiations
21#include "mgr/Command.h"
22std::ostream &Mgr::operator <<(std::ostream &os, const Command &) STUB_RETVAL(os)
23
24#include "mgr/Action.h"
27void Mgr::Action::run(StoreEntry *, bool) STUB
28void Mgr::Action::fillEntry(StoreEntry *, bool) STUB
29void Mgr::Action::add(const Action &) STUB
30void Mgr::Action::respond(const Request &) STUB
31void Mgr::Action::sendResponse(const Ipc::RequestId) STUB
32bool Mgr::Action::atomic() const STUB_RETVAL(false)
33const char * Mgr::Action::name() const STUB_RETVAL(nullptr)
34static Mgr::Command static_Command;
35const Mgr::Command & Mgr::Action::command() const STUB_RETVAL(static_Command)
36StoreEntry * Mgr::Action::createStoreEntry() const STUB_RETVAL(nullptr)
37static Mgr::Action::Pointer dummyAction;
38
39#include "mgr/ActionParams.h"
41Mgr::ActionParams::ActionParams(const Ipc::TypedMsgHdr &) STUB_NOP
42void Mgr::ActionParams::pack(Ipc::TypedMsgHdr &) const STUB
43
44#include "mgr/ActionWriter.h"
45//Mgr::ActionWriter::ActionWriter(const Action::Pointer &, int) STUB
46//protected:
48
49#include "mgr/BasicActions.h"
52//protected:
53//Mgr::MenuAction::MenuAction(const CommandPointer &cmd) STUB
54
57// protected:
58//Mgr::ShutdownAction::ShutdownAction(const CommandPointer &) STUB
59
62//protected:
63//Mgr::ReconfigureAction::ReconfigureAction(const CommandPointer &) STUB
64
67//protected:
68//Mgr::RotateAction::RotateAction(const CommandPointer &) STUB
69
72//protected:
73//Mgr::OfflineToggleAction::OfflineToggleAction(const CommandPointer &) STUB
74
76
77#include "mgr/CountersAction.h"
78//Mgr::CountersActionData::CountersActionData() STUB
80
81Mgr::Action::Pointer Mgr::CountersAction::Create(const CommandPointer &) STUB_RETVAL(dummyAction)
82void Mgr::CountersAction::add(const Action &) STUB
83void Mgr::CountersAction::pack(Ipc::TypedMsgHdr &) const STUB
84void Mgr::CountersAction::unpack(const Ipc::TypedMsgHdr &) STUB
85//protected:
86//Mgr::CountersAction::CountersAction(const CommandPointer &) STUB
87void Mgr::CountersAction::collect() STUB
88void Mgr::CountersAction::dump(StoreEntry *) STUB
89
90#include "mgr/Filler.h"
91//Mgr::Filler::Filler(const Action::Pointer &, int, unsigned int) STUB
92//protected:
93//void Mgr::Filler::start() STUB
94//void Mgr::Filler::swanSong() STUB
95
96#include "mgr/Forwarder.h"
97//Mgr::Forwarder::Forwarder(int, const ActionParams &, HttpRequest *, StoreEntry *) STUB
98//Mgr::Forwarder::~Forwarder() STUB
99//protected:
100//void Mgr::Forwarder::swanSong() STUB
102void Mgr::Forwarder::handleTimeout() STUB
103void Mgr::Forwarder::handleException(const std::exception &) STUB
104
105#include "mgr/FunAction.h"
107void Mgr::FunAction::respond(const Request &) STUB
108//protected:
109//Mgr::FunAction::FunAction(const CommandPointer &, OBJH *) STUB
111
112#include "mgr/InfoAction.h"
113//Mgr::InfoActionData::InfoActionData() STUB
115
116Mgr::Action::Pointer Mgr::InfoAction::Create(const CommandPointer &) STUB_RETVAL(dummyAction)
117void Mgr::InfoAction::add(const Action &) STUB
118void Mgr::InfoAction::respond(const Request &) STUB
119void Mgr::InfoAction::pack(Ipc::TypedMsgHdr &) const STUB
120void Mgr::InfoAction::unpack(const Ipc::TypedMsgHdr &) STUB
121//protected:
122//Mgr::InfoAction::InfoAction(const Mgr::CommandPointer &) STUB
123void Mgr::InfoAction::collect() STUB
124void Mgr::InfoAction::dump(StoreEntry *) STUB
125
126#include "mgr/Inquirer.h"
127//Mgr::Inquirer::Inquirer(Action::Pointer, const Request &, const Ipc::StrandCoords &) STUB
128//protected:
130bool Mgr::Inquirer::doneAll() const STUB_RETVAL(false)
131void Mgr::Inquirer::cleanup() STUB
132void Mgr::Inquirer::sendResponse() STUB
133bool Mgr::Inquirer::aggregate(Ipc::Response::Pointer) STUB_RETVAL(false)
134
135#include "mgr/IntervalAction.h"
136//Mgr::IntervalActionData::IntervalActionData() STUB
138
139//Mgr::Action::Pointer Mgr::IntervalAction::Create5min(const CommandPointer &cmd) STUB_RETVAL(new Mgr::IntervalAction(*cmd))
140//Mgr::Action::Pointer Mgr::IntervalAction::Create60min(const CommandPointer &cmd) STUB_RETVAL(new Mgr::IntervalAction(*cmd))
141void Mgr::IntervalAction::add(const Action&) STUB
142void Mgr::IntervalAction::pack(Ipc::TypedMsgHdr&) const STUB
143void Mgr::IntervalAction::unpack(const Ipc::TypedMsgHdr&) STUB
144//protected:
145//Mgr::IntervalAction::IntervalAction(const CommandPointer &, int, int) STUB
146void Mgr::IntervalAction::collect() STUB
147void Mgr::IntervalAction::dump(StoreEntry*) STUB
148
149#include "mgr/IntParam.h"
150//Mgr::IntParam::IntParam() STUB
151//Mgr::IntParam::IntParam(const std::vector<int>&) STUB
154static std::vector<int> static_vector;
155const std::vector<int>& Mgr::IntParam::value() const STUB_RETVAL(static_vector)
156
157#include "mgr/IoAction.h"
158//Mgr::IoActionData::IoActionData() STUB
160
161Mgr::Action::Pointer Mgr::IoAction::Create(const CommandPointer &) STUB_RETVAL(dummyAction)
162void Mgr::IoAction::add(const Action&) STUB
163void Mgr::IoAction::pack(Ipc::TypedMsgHdr&) const STUB
164void Mgr::IoAction::unpack(const Ipc::TypedMsgHdr&) STUB
165//protected:
166//Mgr::IoAction::IoAction(const CommandPointer &) STUB
167void Mgr::IoAction::collect() STUB
168void Mgr::IoAction::dump(StoreEntry*) STUB
169
170//#include "mgr/QueryParam.h"
171//void Mgr::QueryParam::pack(Ipc::TypedMsgHdr&) const = 0;
172//void Mgr::QueryParam::unpackValue(const Ipc::TypedMsgHdr&) = 0;
173
174#include "mgr/QueryParams.h"
176void Mgr::QueryParams::pack(Ipc::TypedMsgHdr&) const STUB
177void Mgr::QueryParams::unpack(const Ipc::TypedMsgHdr&) STUB
178void Mgr::QueryParams::Parse(Parser::Tokenizer &, QueryParams &) STUB
179//private:
180//Params::const_iterator Mgr::QueryParams::find(const String&) const STUB_RETVAL(new Mgr::Params::const_iterator(*this))
181Mgr::QueryParam::Pointer Mgr::QueryParams::CreateParam(QueryParam::Type) STUB_RETVAL(Mgr::QueryParam::Pointer(nullptr))
182
183#include "mgr/Registration.h"
184//void Mgr::RegisterAction(char const *, char const *, OBJH *, int, int);
185//void Mgr::RegisterAction(char const *, char const *, ClassActionCreationHandler *, int, int);
186
187#include "mgr/Request.h"
188//Mgr::Request::Request(int, unsigned int, int, const Mgr::ActionParams &) STUB
189//Mgr::Request::Request(const Ipc::TypedMsgHdr&) STUB
191Ipc::Request::Pointer Mgr::Request::clone() const STUB_RETVAL(const_cast<Mgr::Request*>(this))
192
193#include "mgr/Response.h"
194//Mgr::Response::Response(unsigned int, Action::Pointer) STUB
195//Mgr::Response::Response(const Ipc::TypedMsgHdr&) STUB
197static Ipc::Response::Pointer ipr_static;
198Ipc::Response::Pointer Mgr::Response::clone() const STUB_RETVAL(Ipc::Response::Pointer(nullptr))
199bool Mgr::Response::hasAction() const STUB_RETVAL(false)
200//static Mgr::Action mgraction_static;
201//const Mgr::Action& Mgr::Response::getAction() const STUB_RETVAL(mgraction_static)
202
203#include "mgr/ServiceTimesAction.h"
204//Mgr::ServiceTimesActionData::ServiceTimesActionData() STUB
206
207Mgr::Action::Pointer Mgr::ServiceTimesAction::Create(const Mgr::CommandPointer &) STUB_RETVAL(Mgr::Action::Pointer(nullptr))
208void Mgr::ServiceTimesAction::add(const Action&) STUB
209void Mgr::ServiceTimesAction::pack(Ipc::TypedMsgHdr&) const STUB
210void Mgr::ServiceTimesAction::unpack(const Ipc::TypedMsgHdr&) STUB
211//protected:
212//Mgr::ServiceTimesAction::ServiceTimesAction(const CommandPointer &) STUB
213void Mgr::ServiceTimesAction::collect() STUB
214void Mgr::ServiceTimesAction::dump(StoreEntry*) STUB
215
216#include "mgr/StoreIoAction.h"
217//Mgr::StoreIoActionData::StoreIoActionData() STUB
219//Mgr::StoreIoAction::StoreIoAction(const CommandPointer &) STUB
220Mgr::Action::Pointer Mgr::StoreIoAction::Create(const CommandPointer &) STUB_RETVAL(Mgr::Action::Pointer(nullptr))
221void Mgr::StoreIoAction::add(const Action&) STUB
222void Mgr::StoreIoAction::pack(Ipc::TypedMsgHdr&) const STUB
223void Mgr::StoreIoAction::unpack(const Ipc::TypedMsgHdr&) STUB
224void Mgr::StoreIoAction::collect() STUB
225void Mgr::StoreIoAction::dump(StoreEntry*) STUB
226
227#include "mgr/StoreToCommWriter.h"
228//Mgr::StoreToCommWriter::StoreToCommWriter(int, StoreEntry *) STUB
230void Mgr::StoreToCommWriter::start() STUB
231void Mgr::StoreToCommWriter::swanSong() STUB
232bool Mgr::StoreToCommWriter::doneAll() const STUB_RETVAL(false)
233void Mgr::StoreToCommWriter::scheduleStoreCopy() STUB
234void Mgr::StoreToCommWriter::noteStoreCopied(StoreIOBuffer) STUB
235void Mgr::StoreToCommWriter::NoteStoreCopied(void*, StoreIOBuffer) STUB
236void Mgr::StoreToCommWriter::HandleStoreAbort(StoreToCommWriter *) STUB
237void Mgr::StoreToCommWriter::scheduleCommWrite(const StoreIOBuffer&) STUB
238void Mgr::StoreToCommWriter::noteCommWrote(const CommIoCbParams&) STUB
239void Mgr::StoreToCommWriter::noteCommClosed(const CommCloseCbParams&) STUB
240void Mgr::StoreToCommWriter::close() STUB
241
242#include "mgr/StringParam.h"
243//Mgr::StringParam::StringParam() STUB
244//Mgr::StringParam::StringParam(const String&) STUB
247static String t;
249
#define STUB
macro to stub a void function.
Definition: STUB.h:33
#define STUB_NOP
Definition: STUB.h:37
#define STUB_RETVAL(x)
Definition: STUB.h:41
struct msghdr with a known type, fixed-size I/O and control buffers
Definition: TypedMsgHdr.h:35
void start() override
called by AsyncStart; do not call directly
Definition: ActionWriter.cc:27
Action(const CommandPointer &aCmd)
Definition: Action.cc:25
~Action() override
Definition: Action.cc:31
store traffic and resource counters
CountersActionData & operator+=(const CountersActionData &stats)
void handleError() override
Definition: Forwarder.cc:76
void respond(const Request &request) override
respond to Coordinator request; default is to collect and sendResponse
Definition: FunAction.cc:38
static Pointer Create(const CommandPointer &cmd, OBJH *aHandler)
Definition: FunAction.cc:25
void dump(StoreEntry *entry) override
Definition: FunAction.cc:48
InfoActionData & operator+=(const InfoActionData &stats)
Definition: InfoAction.cc:32
void start() override
called by AsyncStart; do not call directly
Definition: Inquirer.cc:70
void unpackValue(const Ipc::TypedMsgHdr &msg) override
load parameter value from msg
Definition: IntParam.cc:38
void pack(Ipc::TypedMsgHdr &msg) const override
store parameter into msg
Definition: IntParam.cc:28
const std::vector< int > & value() const
Definition: IntParam.cc:48
IntervalActionData & operator+=(const IntervalActionData &stats)
store size histograms of network read() from peer server
Definition: IoAction.h:22
IoActionData & operator+=(const IoActionData &stats)
Definition: IoAction.cc:30
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:40
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:51
void dump(StoreEntry *entry) override
static Pointer Create(const CommandPointer &cmd)
QueryParam::Pointer get(const String &name) const
returns query parameter by name
Definition: QueryParams.cc:23
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:97
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:85
Pointer clone() const override
returns a copy of this
Definition: Request.cc:55
void pack(Ipc::TypedMsgHdr &msg) const override
prepare for sendmsg()
Definition: Request.cc:44
Ipc::Response::Pointer clone() const override
returns a copy of this
Definition: Response.cc:55
void pack(Ipc::TypedMsgHdr &msg) const override
prepare for sendmsg()
Definition: Response.cc:43
static Pointer Create(const CommandPointer &cmd)
void dump(StoreEntry *entry) override
store service times for 5 and 60 min
ServiceTimesActionData & operator+=(const ServiceTimesActionData &stats)
static Pointer Create(const CommandPointer &cmd)
Definition: BasicActions.cc:67
void dump(StoreEntry *entry) override
Definition: BasicActions.cc:78
Store IO interface data.
Definition: StoreIoAction.h:21
StoreIoActionData & operator+=(const StoreIoActionData &stats)
void pack(Ipc::TypedMsgHdr &msg) const override
store parameter into msg
Definition: StringParam.cc:26
const String & value() const
Definition: StringParam.cc:39
void unpackValue(const Ipc::TypedMsgHdr &msg) override
load parameter value from msg
Definition: StringParam.cc:33
Definition: cf_gen.cc:109
void OBJH(StoreEntry *)
Definition: forward.h:44
Command
what kind of I/O the disker needs to do or have done
Definition: IpcIoFile.h:33
Definition: IpcIoFile.h:24
Cache Manager API.
Definition: Action.h:20
void RegisterBasics()
Registers profiles for the actions above; TODO: move elsewhere?
RefCount< Command > CommandPointer
Definition: forward.h:34
std::ostream & operator<<(std::ostream &os, const ActionProfile &profile)
Definition: ActionProfile.h:42
Generic protocol-agnostic parsing tools.
Definition: RequestParser.h:15
static Parsed Parse(const SBuf &buf)
extracts PROXY protocol v1 header from the given buffer
Definition: Parser.cc:113
STL namespace.

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors