DataProxy.h

Go to the documentation of this file.

#ifndef FWCore_Framework_DataProxy_h
#define FWCore_Framework_DataProxy_h
// -*- C++ -*-
//
// Package:     Framework
// Class  :     DataProxy
//
//
// Author:      Chris Jones
// Created:     Thu Mar 31 12:43:01 EST 2005
//

// system include files
#include <atomic>

// user include files

// forward declarations
namespace edm {
   namespace eventsetup {
      struct ComponentDescription;
      class DataKey;
      class EventSetupRecord;

      class DataProxy {

      public:
         DataProxy();
         virtual ~DataProxy();

         // ---------- const member functions ---------------------
         bool cacheIsValid() const { return cacheIsValid_.load(std::memory_order_acquire); }

         void doGet(EventSetupRecord const& iRecord, DataKey const& iKey, bool iTransiently) const;
         void const* get(EventSetupRecord const&, DataKey const& iKey, bool iTransiently) const;

         ComponentDescription const* providerDescription() const {
            return description_;
         }
         // ---------- static member functions --------------------

         // ---------- member functions ---------------------------
         void invalidate() {
            clearCacheIsValid();
            invalidateCache();
         }

         void resetIfTransient();

         void setProviderDescription(ComponentDescription const* iDesc) {
            description_ = iDesc;
         }
      protected:
         virtual void const* getImpl(EventSetupRecord const&, DataKey const& iKey) =0;

         virtual void invalidateCache() = 0;

         virtual void invalidateTransientCache();

         void clearCacheIsValid();
      private:
         DataProxy(DataProxy const&); // stop default

         DataProxy const& operator=(DataProxy const&); // stop default

         // ---------- member data --------------------------------
         [[cms::thread_safe]] mutable void const* cache_; //protected by a global mutex
         mutable std::atomic<bool> cacheIsValid_;
         mutable std::atomic<bool> nonTransientAccessRequested_;
         ComponentDescription const* description_;
      };
   }
}
#endif