From 7bb07fd27fd4a8b48d2afd8915b6c1ea943890a0 Mon Sep 17 00:00:00 2001 From: Alex Rousskov Date: Tue, 6 Sep 2011 14:26:35 -0600 Subject: [PATCH] Polished API description to explain what a module is and why this API exists. --- src/base/RunnersRegistry.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/base/RunnersRegistry.h b/src/base/RunnersRegistry.h index 4203a88573..f5c7ac645c 100644 --- a/src/base/RunnersRegistry.h +++ b/src/base/RunnersRegistry.h @@ -2,13 +2,21 @@ #define SQUID_BASE_RUNNERSREGISTRY_H /** - * This API allows different modules to register with a well-known registry, + * This API allows virtually any module to register with a well-known registry, * be activated by some central processor at some registry-specific time, and * be deactiveated by some central processor at some registry-specific time. * * For example, main.cc may activate registered I/O modules after parsing * squid.conf and deactivate them before exiting. * + * A module in this context is code providing a functionality or service to the + * rest of Squid, such as src/DiskIO/Blocking, src/fs/ufs, or Cache Manager. A + * module must declare a RegisteredRunner child class to implement activation and + * deactivation logic using the run() method and destructor, respectively. + * + * This API allows the registry to determine the right [de]activation time for + * each group of similar modules, without knowing any module specifics. + * */ /// well-known registries (currently, deactivation is not performed for these) -- 2.47.2