/* * 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_HISTORY_H #define SQUID_SRC_ADAPTATION_HISTORY_H #include "adaptation/DynamicGroupCfg.h" #include "adaptation/forward.h" #include "base/RefCount.h" #include "HttpHeader.h" #include "Notes.h" #include "sbuf/SBuf.h" #include "SquidString.h" namespace Adaptation { /// collects information about adaptations related to a master transaction class History: public RefCountable { public: typedef RefCount Pointer; History(); /// record the start of a xact, return xact history ID int recordXactStart(const String &serviceId, const timeval &when, bool retrying); /// record the end of a xact identified by its history ID void recordXactFinish(int hid); /// dump individual xaction times to a string void allLogString(const char *serviceId, SBuf &); /// dump xaction times, merging retried and retry times together void sumLogString(const char *serviceId, SBuf &); /// sets or resets a cross-transactional database record void updateXxRecord(const char *name, const String &value); /// returns true and fills the record fields iff there is a db record bool getXxRecord(String &name, String &value) const; /// sets or resets next services for the Adaptation::Iterator to notice void updateNextServices(const String &services); /// returns true, fills the value, and resets iff next services were set bool extractNextServices(String &value); /// store the last meta header fields received from the adaptation service void recordMeta(const HttpHeader *lm); void recordAdaptationService(SBuf &srvId); public: /// Last received meta header (REQMOD or RESPMOD, whichever comes last). HttpHeader lastMeta; /// All REQMOD and RESPMOD meta headers merged. Last field wins conflicts. HttpHeader allMeta; /// key:value pairs set by adaptation_meta, to be added to /// AccessLogEntry::notes when ALE becomes available NotePairs::Pointer metaHeaders; typedef std::vector AdaptationServices; AdaptationServices theAdaptationServices; ///< The service groups used /// sets future services for the Adaptation::AccessCheck to notice void setFutureServices(const DynamicGroupCfg &services); /// returns and forgets planned/future services matching the given filter DynamicGroupCfg extractCurrentServices(const ServiceFilter &); private: /// single Xaction stats (i.e., a historical record entry) class Entry { public: Entry(const String &serviceId, const timeval &when); Entry(); // required by Vector<> void stop(); ///< updates stats on transaction end int rptm(); ///< returns response time [msec], calculates it if needed String service; ///< adaptation service ID timeval start; ///< when the xaction was started private: int theRptm; ///< calculated and cached response time value in msec public: bool retried; ///< whether the xaction was replaced by another }; typedef std::vector Entries; Entries theEntries; ///< historical record, in the order of xact starts // theXx* will become a map, but we only support one record String theXxName; ///< name part of the cross-transactional database record String theXxValue; ///< value part of the cross-xactional database record String theNextServices; ///< services Adaptation::Iterator must use next DynamicGroupCfg theFutureServices; ///< services AccessCheck must use }; } // namespace Adaptation #endif /* SQUID_SRC_ADAPTATION_HISTORY_H */