RunnersRegistry.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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.
 */
 
#ifndef SQUID_SRC_BASE_RUNNERSREGISTRY_H
#define SQUID_SRC_BASE_RUNNERSREGISTRY_H
 
class RegisteredRunner
{
public:
    /* Related methods below are declared in their calling order */
 
    /* Configuration events */
 
    virtual void bootstrapConfig() {}
 
    virtual void finalizeConfig() {}
 
    virtual void claimMemoryNeeds() {}
 
    virtual void useConfig() {}
 
    /* Reconfiguration events */
 
    virtual void startReconfigure() {}
 
    virtual void syncConfig() {}
 
    /* Shutdown events */
 
    virtual void startShutdown() {}
 
    virtual void endingShutdown() {}
 
    virtual ~RegisteredRunner() {}
 
    virtual void finishShutdown() {}
 
    typedef void (RegisteredRunner::*Method)();
 
};
 
bool RegisterRunner(RegisteredRunner *rr);
 
void RunRegistered(const RegisteredRunner::Method &m);
 
class IndependentRunner: public RegisteredRunner
{
public:
    ~IndependentRunner() override { unregisterRunner(); }
 
protected:
    void registerRunner();
    void unregisterRunner(); 
};
 
#define RunRegisteredHere(m) \
    debugs(1, 2, "running " # m); \
    RunRegistered(&m)
 
#define NameRunnerRegistrator_(Namespace, ClassName) \
    Register ## ClassName ## In ## Namespace()
 
#define DefineRunnerRegistrator_(Namespace, ClassName, Constructor) \
    void NameRunnerRegistrator_(Namespace, ClassName); \
    void NameRunnerRegistrator_(Namespace, ClassName) { \
        const auto registered = RegisterRunner(new Constructor); \
        assert(registered); \
    }
 
#define DefineRunnerRegistratorIn(Namespace, ClassName) \
    DefineRunnerRegistrator_(Namespace, ClassName, Namespace::ClassName)
 
#define DefineRunnerRegistrator(ClassName) \
    DefineRunnerRegistrator_(Global, ClassName, ClassName)
 
#define CallRunnerRegistratorIn(Namespace, ClassName) \
    do { \
        void NameRunnerRegistrator_(Namespace, ClassName); \
        NameRunnerRegistrator_(Namespace, ClassName); \
    } while (false)
 
#define CallRunnerRegistrator(ClassName) \
    CallRunnerRegistratorIn(Global, ClassName)
 
#endif /* SQUID_SRC_BASE_RUNNERSREGISTRY_H */