SharedResourcesRegistry.h

Go to the documentation of this file.

#ifndef FWCore_Framework_SharedResourcesRegistry_h
#define FWCore_Framework_SharedResourcesRegistry_h
// -*- C++ -*-
//
// Package:     FWCore/Framework
// Class  :     SharedResourcesRegistry
//
//
// Original Author:  Chris Jones
//         Created:  Sun, 06 Oct 2013 15:48:44 GMT
//

// system include files
#include <vector>
#include <string>
#include <map>
#include <mutex>
#include <memory>

#include "FWCore/Concurrency/interface/SerialTaskQueue.h"
#include "FWCore/Utilities/interface/propagate_const.h"

// user include files

// forward declarations
class testSharedResourcesRegistry;

namespace edm {
  class SharedResourcesAcquirer;

  class SharedResourcesRegistry {
  public:
    //needed for testing
    friend class ::testSharedResourcesRegistry;

    SharedResourcesRegistry(const SharedResourcesRegistry&) = delete;                   // stop default
    const SharedResourcesRegistry& operator=(const SharedResourcesRegistry&) = delete;  // stop default

    // ---------- const member functions ---------------------
    SharedResourcesAcquirer createAcquirer(std::vector<std::string> const&) const;

    std::pair<SharedResourcesAcquirer, std::shared_ptr<std::recursive_mutex>> createAcquirerForSourceDelayedReader();

    // ---------- static member functions --------------------
    static SharedResourcesRegistry* instance();

    static const std::string kLegacyModuleResourceName;

    // ---------- member functions ---------------------------
    void registerSharedResource(const std::string&);

#ifdef SHAREDRESOURCETESTACCESSORS
    // The next function is intended to be used only in a unit test
    std::map<std::string, std::pair<std::shared_ptr<SerialTaskQueue>, unsigned int>> const& resourceMap() const {
      return resourceMap_;
    }
#endif

  private:
    SharedResourcesRegistry();
    ~SharedResourcesRegistry() = default;

    // ---------- member data --------------------------------
    std::map<std::string, std::pair<std::shared_ptr<SerialTaskQueue>, unsigned int>> resourceMap_;

    edm::propagate_const<std::shared_ptr<std::recursive_mutex>> resourceForDelayedReader_;

    edm::propagate_const<std::shared_ptr<SerialTaskQueue>> queueForDelayedReader_;

    unsigned int nLegacy_;
  };
}  // namespace edm

#endif