edm::eventsetup::ESSourceDataProxyBase Class Reference

#include <ESSourceDataProxyBase.h>

Inheritance diagram for edm::eventsetup::ESSourceDataProxyBase:

Public Member Functions
	ESSourceDataProxyBase ()
Public Member Functions inherited from edm::eventsetup::DataProxy
bool	cacheIsValid () const
	DataProxy ()
	DataProxy (DataProxy const &)=delete
void const *	get (EventSetupRecordImpl const &, DataKey const &, bool iTransiently, ActivityRegistry const *, EventSetupImpl const *, ESParentContext const &) const
void const *	getAfterPrefetch (const EventSetupRecordImpl &iRecord, const DataKey &iKey, bool iTransiently) const
virtual void	initializeForNewIOV ()
void	invalidate ()
DataProxy const &	operator= (DataProxy const &)=delete
void	prefetchAsync (WaitingTaskHolder, EventSetupRecordImpl const &, DataKey const &, EventSetupImpl const *, ServiceToken const &, ESParentContext const &) const
ComponentDescription const *	providerDescription () const
	returns the description of the DataProxyProvider which owns this Proxy More...
void	resetIfTransient ()
void	setProviderDescription (ComponentDescription const *iDesc)
virtual	~DataProxy ()

Protected Member Functions
void	invalidateCache () override
void	invalidateTransientCache () override
virtual void	prefetch (edm::eventsetup::DataKey const &iKey, EventSetupRecordDetails)=0
template<typename ASYNC , typename GUARD >
void	prefetchAsyncImplTemplate (ASYNC iAsync, GUARD iGuardFactory, edm::WaitingTaskHolder iTask, edm::eventsetup::EventSetupRecordImpl const &iRecord, edm::eventsetup::DataKey const &iKey, edm::ESParentContext const &iContext)
Protected Member Functions inherited from edm::eventsetup::DataProxy
void	clearCacheIsValid ()
virtual void const *	getAfterPrefetchImpl () const =0
virtual void	prefetchAsyncImpl (WaitingTaskHolder, EventSetupRecordImpl const &, DataKey const &iKey, EventSetupImpl const *, ServiceToken const &, ESParentContext const &)=0

Private Member Functions
void	doPrefetchAndSignals (edm::eventsetup::EventSetupRecordImpl const &, edm::eventsetup::DataKey const &iKey, edm::ESParentContext const &)
template<typename GUARD >
void	guardPrefetch (GUARD iGuardFactory, edm::eventsetup::EventSetupRecordImpl const &iES, edm::eventsetup::DataKey const &iKey, edm::ESParentContext const &iContext)
bool	needToPrefetch (edm::WaitingTaskHolder iTask)

Private Attributes
std::atomic< bool >	m_prefetching
edm::WaitingTaskList	m_waitingList

Detailed Description

Definition at line 35 of file ESSourceDataProxyBase.h.

Constructor & Destructor Documentation

edm::eventsetup::ESSourceDataProxyBase::ESSourceDataProxyBase ( )

inline

Definition at line 37 of file ESSourceDataProxyBase.h.

: m_prefetching{false} {}

Member Function Documentation

void ESSourceDataProxyBase::doPrefetchAndSignals ( edm::eventsetup::EventSetupRecordImpl const &  iRecord, edm::eventsetup::DataKey const &  iKey, edm::ESParentContext const &  iParent  )

private

Definition at line 31 of file ESSourceDataProxyBase.cc.

References edm::eventsetup::EventSetupRecordImpl::activityRegistry(), visDQMUpload::context, edm::signalslot::Signal< T >::emit(), edm::eventsetup::EventSetupRecordImpl::key(), edm::ESModuleCallingContext::kRunning, and edm::ActivityRegistry::preESModuleSignal_.

Referenced by guardPrefetch().

                                                                                                     {
  edm::ESModuleCallingContext context(providerDescription(), ESModuleCallingContext::State::kRunning, iParent);
  iRecord.activityRegistry()->preESModuleSignal_.emit(iRecord.key(), context);
  struct EndGuard {
    EndGuard(EventSetupRecordImpl const& iRecord, ESModuleCallingContext const& iContext)
        : record_{iRecord}, context_{iContext} {}
    ~EndGuard() { record_.activityRegistry()->postESModuleSignal_.emit(record_.key(), context_); }
    EventSetupRecordImpl const& record_;
    ESModuleCallingContext const& context_;
  } guardAR(iRecord, context);
  prefetch(iKey, EventSetupRecordDetails(&iRecord));
}

template<typename GUARD >

void edm::eventsetup::ESSourceDataProxyBase::guardPrefetch ( GUARD  iGuardFactory, edm::eventsetup::EventSetupRecordImpl const &  iES, edm::eventsetup::DataKey const &  iKey, edm::ESParentContext const &  iContext  )

inlineprivate

Definition at line 71 of file ESSourceDataProxyBase.h.

References doPrefetchAndSignals().

Referenced by prefetchAsyncImplTemplate().

                                                           {
      [[maybe_unused]] auto guard = iGuardFactory();
      doPrefetchAndSignals(iES, iKey, iContext);
    }

void edm::eventsetup::ESSourceDataProxyBase::invalidateCache ( )

inlineoverrideprotectedvirtual

indicates that the Proxy should invalidate any cached information as that information has 'expired' (i.e. we have moved to a new IOV)

Implements edm::eventsetup::DataProxy.

Definition at line 40 of file ESSourceDataProxyBase.h.

References m_prefetching, m_waitingList, and edm::WaitingTaskList::reset().

                                    {
      m_waitingList.reset();
      m_prefetching = false;
    }

void edm::eventsetup::ESSourceDataProxyBase::invalidateTransientCache ( )

inlineoverrideprotectedvirtual

indicates that the Proxy should invalidate any cached information as that information was accessed transiently and therefore is not intended to be kept over the entire IOV. Default is to call invalidateCache().

Reimplemented from edm::eventsetup::DataProxy.

Definition at line 44 of file ESSourceDataProxyBase.h.

{}

bool ESSourceDataProxyBase::needToPrefetch ( edm::WaitingTaskHolder  iTask )

private

Definition at line 25 of file ESSourceDataProxyBase.cc.

References edm::WaitingTaskList::add(), m_prefetching, m_waitingList, and eostools::move().

Referenced by prefetchAsyncImplTemplate().

                                                                                  {
  m_waitingList.add(std::move(iTask));
  bool expected = false;
  return m_prefetching.compare_exchange_strong(expected, true);
}

virtual void edm::eventsetup::ESSourceDataProxyBase::prefetch ( edm::eventsetup::DataKey const &  iKey, EventSetupRecordDetails    )

protectedpure virtual

Implemented in DataProxy< RecordT, DataT, Initializer >.

template<typename ASYNC , typename GUARD >

void edm::eventsetup::ESSourceDataProxyBase::prefetchAsyncImplTemplate ( ASYNC  iAsync, GUARD  iGuardFactory, edm::WaitingTaskHolder  iTask, edm::eventsetup::EventSetupRecordImpl const &  iRecord, edm::eventsetup::DataKey const &  iKey, edm::ESParentContext const &  iContext  )

inlineprotected

Definition at line 50 of file ESSourceDataProxyBase.h.

References edm::WaitingTaskList::doneWaiting(), edm::WaitingTaskHolder::group(), watchdog::group, guardPrefetch(), m_waitingList, eostools::move(), and needToPrefetch().

Referenced by edm::eventsetup::ESSourceDataProxyConcurrentBase::prefetchAsyncImpl(), and edm::eventsetup::ESSourceDataProxyNonConcurrentBase::prefetchAsyncImpl().

                                                                       {
      auto group = iTask.group();
      if (needToPrefetch(std::move(iTask))) {
        iAsync(*group, [this, iGuardFactory, &iRecord, iKey, iContext]() {
          try {
            guardPrefetch(iGuardFactory, iRecord, iKey, iContext);
            m_waitingList.doneWaiting(std::exception_ptr{});
          } catch (...) {
            m_waitingList.doneWaiting(std::current_exception());
          }
        });
      }
    }

Member Data Documentation

std::atomic<bool> edm::eventsetup::ESSourceDataProxyBase::m_prefetching

private

Definition at line 88 of file ESSourceDataProxyBase.h.

Referenced by invalidateCache(), and needToPrefetch().

edm::WaitingTaskList edm::eventsetup::ESSourceDataProxyBase::m_waitingList

private

Definition at line 87 of file ESSourceDataProxyBase.h.

Referenced by invalidateCache(), needToPrefetch(), and prefetchAsyncImplTemplate().