dunedaq::cmdlib::CommandFacility Class Reference

Interface needed by DAQ apps and services for command handling. More...

#include <CommandFacility.hpp>

Collaboration diagram for dunedaq::cmdlib::CommandFacility:

Public Member Functions
	CommandFacility (std::string)
virtual	~CommandFacility ()
	CommandFacility (const CommandFacility &)=delete
	CommandFacility is not copy-constructible.
CommandFacility &	operator= (const CommandFacility &)=delete
	CommandFacility is not copy-assignable.
	CommandFacility (CommandFacility &&)=delete
	CommandFacility is not move-constructible.
CommandFacility &	operator= (CommandFacility &&)=delete
	CommandFacility is not move-assignable.
void	set_commanded (CommandedObject &commanded, std::string name)
	Meant to be called once from main.
virtual void	run (std::atomic< bool > &end_marker)=0
	Meant to be called once from main (implementation specific).
void	execute_command (const cmdobj_t &cmd, cmd::CommandReply meta)
	Feed commands from the implementation.

Protected Member Functions
virtual void	completion_callback (const cmdobj_t &cmd, cmd::CommandReply &meta)=0
	Must be implemented to handling the results of the commands.

Protected Attributes
std::string	m_name
	name of the commanded object

Private Types
typedef tbb::concurrent_queue< std::future< void > >	CompletionQueue
	Completion queue for reqistered tasks.
typedef std::function< void(const cmdobj_t &, cmd::CommandReply)>	CommandCallback
	Request callback function signature.

Private Member Functions
void	handle_command (const cmdobj_t &cmd, cmd::CommandReply meta)
	The glue between commanded and completion callback.
void	executor ()

Private Attributes
CommandedObject *	m_commanded_object = nullptr
	Commanded Object to run execute with received commands as parameters.
CompletionQueue	m_completion_queue
CommandCallback	m_command_callback = nullptr
std::atomic< bool >	m_active
	Single thrad is responsible to trigger tasks.
std::thread	m_executor

Detailed Description

Interface needed by DAQ apps and services for command handling.

Definition at line 49 of file CommandFacility.hpp.

Member Typedef Documentation

CommandCallback

typedef std::function<void(const cmdobj_t&, cmd::CommandReply)> dunedaq::cmdlib::CommandFacility::CommandCallback

private

Request callback function signature.

Definition at line 89 of file CommandFacility.hpp.

CompletionQueue

typedef tbb::concurrent_queue<std::future<void> > dunedaq::cmdlib::CommandFacility::CompletionQueue

private

Completion queue for reqistered tasks.

Definition at line 85 of file CommandFacility.hpp.

Constructor & Destructor Documentation

CommandFacility() [1/3]

dunedaq::cmdlib::CommandFacility::CommandFacility ( std::string )

inlineexplicit

Definition at line 52 of file CommandFacility.hpp.

{}

~CommandFacility()

CommandFacility::~CommandFacility ( )

virtual

Definition at line 21 of file CommandFacility.cpp.

{
  if (m_active.load()) {
    m_active.store(false);
    if (m_executor.joinable()) {
      m_executor.join();
    }
  }
}

CommandFacility() [2/3]

dunedaq::cmdlib::CommandFacility::CommandFacility ( const CommandFacility & )

delete

CommandFacility is not copy-constructible.

CommandFacility() [3/3]

dunedaq::cmdlib::CommandFacility::CommandFacility ( CommandFacility && )

delete

CommandFacility is not move-constructible.

Member Function Documentation

completion_callback()

virtual void dunedaq::cmdlib::CommandFacility::completion_callback ( const cmdobj_t & cmd, cmd::CommandReply & meta )

protectedpure virtual

Must be implemented to handling the results of the commands.

execute_command()

void CommandFacility::execute_command	(	const cmdobj_t &	cmd,
		cmd::CommandReply	meta )

Feed commands from the implementation.

Definition at line 47 of file CommandFacility.cpp.

{
  auto execfut = std::async(std::launch::deferred, m_command_callback, std::move(cmd), std::move(meta));
  m_completion_queue.push(std::move(execfut));
}

executor()

void CommandFacility::executor ( )

private

Definition at line 81 of file CommandFacility.cpp.

{
  std::future<void> fut;
  while (m_active.load()) {
    if (m_completion_queue.empty()) {
      std::this_thread::sleep_for(std::chrono::milliseconds(10));
    } else {
      bool success = m_completion_queue.try_pop(fut);
      if (!success) {
        ers::error(CompletionQueueIssue(ERS_HERE, "Can't get from completion queue."));
      } else {
        fut.wait(); // trigger execution
      }
    }
  }
}

handle_command()

void CommandFacility::handle_command ( const cmdobj_t & cmd, cmd::CommandReply meta )

private

The glue between commanded and completion callback.

Definition at line 54 of file CommandFacility.cpp.

{
  try {
    m_commanded_object->execute(cmd);
    meta.success = true;
    meta.result = "OK";
    meta.appname = m_name;
  } catch (const ers::Issue& ei) {
    meta.success = false;
    meta.result = ei.what();
    meta.appname = m_name;
    ers::error(CommandExecutionFailed(ERS_HERE, "Caught ers::Issue", ei));
  } catch (const std::exception& exc) {
    meta.success = false;
    meta.result = exc.what();
    meta.appname = m_name;
    ers::error(CommandExecutionFailed(ERS_HERE, "Caught std::exception", exc));
  } catch (...) { // NOLINT JCF Jan-27-2021 violates letter of the law but not the spirit
    meta.success = false;
    meta.result = "Caught unknown exception";
    meta.appname = m_name;
    ers::error(CommandExecutionFailed(ERS_HERE, meta.result));
  }
  completion_callback(cmd, meta);
}

operator=() [1/2]

CommandFacility & dunedaq::cmdlib::CommandFacility::operator= ( CommandFacility && )

delete

CommandFacility is not move-assignable.

operator=() [2/2]

CommandFacility & dunedaq::cmdlib::CommandFacility::operator= ( const CommandFacility & )

delete

CommandFacility is not copy-assignable.

run()

virtual void dunedaq::cmdlib::CommandFacility::run ( std::atomic< bool > & end_marker )

pure virtual

Meant to be called once from main (implementation specific).

set_commanded()

void CommandFacility::set_commanded	(	CommandedObject &	commanded,
		std::string	name )

Meant to be called once from main.

Definition at line 32 of file CommandFacility.cpp.

{
  if (m_commanded_object == nullptr) {
    m_name = name;
    m_commanded_object = &commanded;
    m_command_callback =
      std::bind(&CommandFacility::handle_command, this, std::placeholders::_1, std::placeholders::_2);
    m_active.store(true);
    m_executor = std::thread(&CommandFacility::executor, this);
  } else {
    ers::error(CommandFacilityInitialization(ERS_HERE, "set_commanded shall be called once."));
  }
}

Member Data Documentation

m_active

std::atomic<bool> dunedaq::cmdlib::CommandFacility::m_active

private

Single thrad is responsible to trigger tasks.

Definition at line 93 of file CommandFacility.hpp.

m_command_callback

CommandCallback dunedaq::cmdlib::CommandFacility::m_command_callback = nullptr

private

Definition at line 90 of file CommandFacility.hpp.

m_commanded_object

CommandedObject* dunedaq::cmdlib::CommandFacility::m_commanded_object = nullptr

mutableprivate

Commanded Object to run execute with received commands as parameters.

Definition at line 82 of file CommandFacility.hpp.

m_completion_queue

CompletionQueue dunedaq::cmdlib::CommandFacility::m_completion_queue

private

Definition at line 86 of file CommandFacility.hpp.

m_executor

std::thread dunedaq::cmdlib::CommandFacility::m_executor

private

Definition at line 95 of file CommandFacility.hpp.

m_name

std::string dunedaq::cmdlib::CommandFacility::m_name

protected

name of the commanded object

Definition at line 73 of file CommandFacility.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/cmdlib/include/cmdlib/CommandFacility.hpp
• /github/workspace/dunedaq/sourcecode/cmdlib/src/CommandFacility.cpp