CallbackProxy.h

Go to the documentation of this file.

#ifndef Framework_CallbackProxy_h
#define Framework_CallbackProxy_h
// -*- C++ -*-
//
// Package:     Framework
// Class  :     CallbackProxy
//
//
// Author:      Chris Jones
// Created:     Fri Apr  8 11:50:21 CDT 2005
//

// system include files
#include <cassert>
#include <memory>

// user include files
#include "FWCore/Framework/interface/DataProxy.h"
#include "FWCore/Framework/interface/EventSetupRecord.h"
#include "FWCore/Concurrency/interface/WaitingTaskList.h"
#include "FWCore/Concurrency/interface/WaitingTaskHolder.h"

#include "FWCore/Framework/interface/produce_helpers.h"
#include "FWCore/Utilities/interface/propagate_const.h"

// forward declarations
namespace edm::eventsetup {

  template <class CallbackT, class RecordT, class DataT>
  class CallbackProxy final : public DataProxy {
  public:
    using smart_pointer_traits = produce::smart_pointer_traits<DataT>;
    using ValueType = typename smart_pointer_traits::type;
    using RecordType = RecordT;

    CallbackProxy(std::shared_ptr<CallbackT>& iCallback) : callback_{iCallback} {
      //The callback fills the data directly.  This is done so that the callback does not have to
      //  hold onto a temporary copy of the result of the callback since the callback is allowed
      //  to return multiple items where only one item is needed by this Proxy
      iCallback->holdOntoPointer(&data_);
    }

    ~CallbackProxy() final {
      DataT* dummy(nullptr);
      callback_->holdOntoPointer(dummy);
    }

    void prefetchAsyncImpl(WaitingTaskHolder iWaitTask,
                           const EventSetupRecordImpl& iRecord,
                           const DataKey&,
                           EventSetupImpl const* iEventSetupImpl,
                           ServiceToken const& iToken,
                           edm::ESParentContext const& iParent) final {
      assert(iRecord.key() == RecordT::keyForClass());
      callback_->prefetchAsync(iWaitTask, &iRecord, iEventSetupImpl, iToken, iParent);
    }

    void const* getAfterPrefetchImpl() const final { return smart_pointer_traits::getPointer(data_); }

    void invalidateCache() override {
      data_ = DataT{};
      callback_->newRecordComing();
    }

    // Delete copy operations
    CallbackProxy(const CallbackProxy&) = delete;
    const CallbackProxy& operator=(const CallbackProxy&) = delete;

  private:
    DataT data_{};
    edm::propagate_const<std::shared_ptr<CallbackT>> callback_;
  };

}  // namespace edm::eventsetup

#endif