/* * 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. */ #ifndef SQUID_SRC_ADAPTATION_SERVICE_H #define SQUID_SRC_ADAPTATION_SERVICE_H #include "AccessLogEntry.h" #include "adaptation/Elements.h" #include "adaptation/forward.h" #include "adaptation/ServiceConfig.h" #include "base/RefCount.h" #include "http/forward.h" #include "SquidString.h" // TODO: Move src/ICAP/ICAPServiceRep.h API comments here and update them namespace Adaptation { // manages adaptation service configuration in squid.conf // specific adaptation mechanisms extend this class class Service: public RefCountable { public: typedef RefCount Pointer; typedef String Id; public: explicit Service(const ServiceConfigPointer &aConfig); ~Service() override; virtual bool probed() const = 0; // see comments above virtual bool broken() const; virtual bool up() const = 0; // see comments above virtual Initiate *makeXactLauncher(Http::Message *virginHeader, HttpRequest *virginCause, AccessLogEntry::Pointer &alp) = 0; bool wants(const ServiceFilter &filter) const; // the methods below can only be called on an up() service virtual bool wantsUrl(const SBuf &urlPath) const = 0; // called by transactions to report service failure virtual void noteFailure() = 0; const ServiceConfig &cfg() const { return *theConfig; } virtual void finalize(); // called after creation /// called when removed from the config; the service will be /// auto-destroyed when the last refcounting user leaves virtual void detach() = 0; /// whether detached() was called virtual bool detached() const = 0; protected: ServiceConfig &writeableCfg() { return *theConfig; } private: ServiceConfigPointer theConfig; }; typedef Service::Pointer ServicePointer; typedef std::vector Services; Services &AllServices(); ServicePointer FindService(const Service::Id &key); /// detach all adaptation services from current configuration void DetachServices(); } // namespace Adaptation #endif /* SQUID_SRC_ADAPTATION_SERVICE_H */