dunedaq::iomanager::QueueRegistry Class Reference

The QueueRegistry class manages all Queue instances and gives out handles to the Queues upon request. More...

#include <QueueRegistry.hpp>

Classes
struct	QueueEntry

Public Member Functions
	~QueueRegistry ()=default
	QueueRegistry destructor.
template<typename T >
std::shared_ptr< Queue< T > >	get_queue (const std::string &name)
	Get a handle to a Queue.
void	configure (const std::vector< const confmodel::Queue * > &configs, opmonlib::OpMonManager &)
	Configure the QueueRegistry.
void	shutdown ()
bool	has_queue (std::string const &uid, std::string const &data_type) const
std::set< std::string >	get_datatypes (std::string const &uid) const

Static Public Member Functions
static QueueRegistry &	get ()
	Get a handle to the QueueRegistry.
static void	reset ()

Private Member Functions
	QueueRegistry ()=default
template<typename T >
std::shared_ptr< QueueBase >	create_queue (const confmodel::Queue *config)
	QueueRegistry (const QueueRegistry &)=delete
QueueRegistry &	operator= (const QueueRegistry &)=delete
	QueueRegistry (QueueRegistry &&)=delete
QueueRegistry &	operator= (QueueRegistry &&)=delete

Private Attributes
std::map< std::string, QueueEntry >	m_queue_registry
std::vector< const confmodel::Queue * >	m_queue_configs
std::shared_ptr< opmonlib::OpMonLink >	m_opmon_link { std::make_shared<opmonlib::OpMonLink>() }
bool	m_configured { false }

Static Private Attributes
static std::unique_ptr< QueueRegistry >	s_instance = nullptr

Detailed Description

The QueueRegistry class manages all Queue instances and gives out handles to the Queues upon request.

Definition at line 34 of file QueueRegistry.hpp.

Constructor & Destructor Documentation

~QueueRegistry()

dunedaq::iomanager::QueueRegistry::~QueueRegistry ( )

default

QueueRegistry destructor.

QueueRegistry() [1/3]

dunedaq::iomanager::QueueRegistry::QueueRegistry ( )

privatedefault

QueueRegistry() [2/3]

dunedaq::iomanager::QueueRegistry::QueueRegistry ( const QueueRegistry & )

privatedelete

QueueRegistry() [3/3]

dunedaq::iomanager::QueueRegistry::QueueRegistry ( QueueRegistry && )

privatedelete

Member Function Documentation

configure()

void dunedaq::iomanager::QueueRegistry::configure	(	const std::vector< const confmodel::Queue * > &	configs,
		opmonlib::OpMonManager &	mgr )

Configure the QueueRegistry.

Parameters

configs

Queue configurations

Definition at line 31 of file QueueRegistry.cpp.

{
  if (m_configured) {
    throw QueueRegistryConfigured(ERS_HERE);
  }
 
  m_queue_configs = configs;
 
  mgr.register_node("queues", m_opmon_link);
  
  m_configured = true;
}

create_queue()

template<typename T >

std::shared_ptr< QueueBase > dunedaq::iomanager::QueueRegistry::create_queue ( const confmodel::Queue * config )

private

Definition at line 53 of file QueueRegistry.hxx.

{
  std::shared_ptr<QueueBase> queue;
  auto type = config->get_queue_type();
  if (type == confmodel::Queue::Queue_type::KStdDeQueue) {
    queue = std::make_shared<StdDeQueue<T>>(config->UID(), config->get_capacity());
  } else if (type == confmodel::Queue::Queue_type::KFollySPSCQueue) {
    queue = std::make_shared<FollySPSCQueue<T>>(config->UID(), config->get_capacity());
  } else if (type == confmodel::Queue::Queue_type::KFollyMPMCQueue) {
    queue = std::make_shared<FollyMPMCQueue<T>>(config->UID(), config->get_capacity());
  } else {
    throw QueueTypeUnknown(ERS_HERE, config->get_queue_type());
  }
 
  m_opmon_link->register_node(config->UID(), queue);
 
  return queue;
}

get()

QueueRegistry & dunedaq::iomanager::QueueRegistry::get ( )

static

Get a handle to the QueueRegistry.

Returns

QueueRegistry handle

Definition at line 22 of file QueueRegistry.cpp.

{
  if (!s_instance) {
    s_instance.reset(new QueueRegistry());
  }
  return *s_instance;
}

get_datatypes()

std::set< std::string > dunedaq::iomanager::QueueRegistry::get_datatypes

(

std::string const &

uid

)

const

Definition at line 58 of file QueueRegistry.cpp.

{
  std::set<std::string> output;
 
  for (auto& config : m_queue_configs) {
    if (config->UID() == uid) {
      output.insert(config->get_data_type());
    }
  }
 
  return output;
}

get_queue()

template<typename T >

std::shared_ptr< Queue< T > > dunedaq::iomanager::QueueRegistry::get_queue

(

const std::string &

name

)

Get a handle to a Queue.

Template Parameters

T	Type of the data stored in the Queue

Parameters

name	Name of the Queue

Returns

std::shared_ptr to generic queue pointer

Definition at line 12 of file QueueRegistry.hxx.

{
 
  auto queue_it = m_queue_registry.find(name);
  if (queue_it != m_queue_registry.end()) {
    auto queuePtr = std::dynamic_pointer_cast<Queue<T>>(queue_it->second.m_instance);
 
    if (!queuePtr) {
      // TODO: John Freeman (jcfree@fnal.gov), Jun-23-2020. Add checks for demangling status. Timescale 2 weeks.
      int status = -999;
      std::string realname_target = abi::__cxa_demangle(typeid(T).name(), nullptr, nullptr, &status);
      std::string realname_source = abi::__cxa_demangle(queue_it->second.m_type->name(), nullptr, nullptr, &status);
 
      throw QueueTypeMismatch(ERS_HERE, name, realname_source, realname_target);
    }
 
    return queuePtr;
  }
 
  const confmodel::Queue* qptr = nullptr;
  for(auto& qcfg : m_queue_configs) {
    if (qcfg->UID() == name) {
      qptr = qcfg;
      break;
    }
  }
  if (qptr != nullptr) {
    QueueEntry entry = { qptr, &typeid(T), create_queue<T>(qptr) };
    m_queue_registry[name] = entry;
    return std::dynamic_pointer_cast<Queue<T>>(entry.m_instance);
 
  } else {
    // TODO: John Freeman (jcfree@fnal.gov), Jun-23-2020. Add checks for demangling status. Timescale 2 weeks.
    int status = -999;
    std::string realname_target = abi::__cxa_demangle(typeid(T).name(), nullptr, nullptr, &status);
    throw QueueNotFound(ERS_HERE, name, realname_target);
  }
}

has_queue()

bool dunedaq::iomanager::QueueRegistry::has_queue	(	std::string const &	uid,
		std::string const &	data_type ) const

Definition at line 46 of file QueueRegistry.cpp.

{
  for (auto& config : m_queue_configs) {
    if (config->UID() == uid && config->get_data_type() == data_type) {
      return true;
    }
  }
 
  return false;
}

operator=() [1/2]

QueueRegistry & dunedaq::iomanager::QueueRegistry::operator= ( const QueueRegistry & )

privatedelete

operator=() [2/2]

QueueRegistry & dunedaq::iomanager::QueueRegistry::operator= ( QueueRegistry && )

privatedelete

reset()

static void dunedaq::iomanager::QueueRegistry::reset ( )

inlinestatic

Definition at line 64 of file QueueRegistry.hpp.

{ s_instance.reset(nullptr); }

shutdown()

void dunedaq::iomanager::QueueRegistry::shutdown ( )

inline

Definition at line 65 of file QueueRegistry.hpp.

{ m_queue_registry.clear(); }

Member Data Documentation

m_configured

bool dunedaq::iomanager::QueueRegistry::m_configured { false }

private

Definition at line 88 of file QueueRegistry.hpp.

{ false };

m_opmon_link

std::shared_ptr<opmonlib::OpMonLink> dunedaq::iomanager::QueueRegistry::m_opmon_link { std::make_shared<opmonlib::OpMonLink>() }

private

Definition at line 86 of file QueueRegistry.hpp.

{ std::make_shared<opmonlib::OpMonLink>() };

m_queue_configs

std::vector<const confmodel::Queue*> dunedaq::iomanager::QueueRegistry::m_queue_configs

private

Definition at line 85 of file QueueRegistry.hpp.

m_queue_registry

std::map<std::string, QueueEntry> dunedaq::iomanager::QueueRegistry::m_queue_registry

private

Definition at line 84 of file QueueRegistry.hpp.

s_instance

std::unique_ptr< QueueRegistry > dunedaq::iomanager::QueueRegistry::s_instance = nullptr

staticprivate

Definition at line 90 of file QueueRegistry.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/iomanager/include/iomanager/queue/QueueRegistry.hpp
• /github/workspace/dunedaq/sourcecode/iomanager/include/iomanager/queue/detail/QueueRegistry.hxx
• /github/workspace/dunedaq/sourcecode/iomanager/src/queue/QueueRegistry.cpp