dunedaq::hsilibs::HSIEventSender Class Reference

HSIEventSender provides an interface to process and and send HSIEvents. More...

#include <HSIEventSender.hpp>

Inheritance diagram for dunedaq::hsilibs::HSIEventSender:

Collaboration diagram for dunedaq::hsilibs::HSIEventSender:

Public Member Functions
	HSIEventSender (const std::string &name)
	HSIEventSender Constructor.
	HSIEventSender (const HSIEventSender &)=delete
	HSIEventSender is not copy-constructible.
HSIEventSender &	operator= (const HSIEventSender &)=delete
	HSIEventSender is not copy-assignable.
	HSIEventSender (HSIEventSender &&)=delete
	HSIEventSender is not move-constructible.
HSIEventSender &	operator= (HSIEventSender &&)=delete
	HSIEventSender is not move-assignable.
void	init (std::shared_ptr< appfwk::ConfigurationManager > mcfg) override

Protected Types
using	raw_sender_ct = iomanager::SenderConcept<HSI_FRAME_STRUCT>
using	hsievent_sender_ct = iomanager::SenderConcept<dfmessages::HSIEvent>

Protected Member Functions
virtual void	do_configure (const CommandData_t &obj)=0
virtual void	do_start (const CommandData_t &obj)=0
virtual void	do_stop (const CommandData_t &obj)=0
virtual void	do_scrap (const CommandData_t &obj)=0
virtual bool	ready_to_send (std::chrono::milliseconds timeout)
virtual void	send_hsi_event (dfmessages::HSIEvent &event)
virtual void	send_raw_hsi_data (const std::array< uint32_t, 7 > &raw_data, raw_sender_ct *sender)

Protected Attributes
std::string	m_hsievent_send_connection
std::chrono::milliseconds	m_queue_timeout
std::shared_ptr< hsievent_sender_ct >	m_hsievent_sender
std::atomic< uint64_t >	m_sent_counter
std::atomic< uint64_t >	m_failed_to_send_counter
std::atomic< uint64_t >	m_last_sent_timestamp

Detailed Description

HSIEventSender provides an interface to process and and send HSIEvents.

Definition at line 33 of file HSIEventSender.hpp.

Member Typedef Documentation

hsievent_sender_ct

using dunedaq::hsilibs::HSIEventSender::hsievent_sender_ct = iomanager::SenderConcept<dfmessages::HSIEvent>

protected

Definition at line 62 of file HSIEventSender.hpp.

raw_sender_ct

using dunedaq::hsilibs::HSIEventSender::raw_sender_ct = iomanager::SenderConcept<HSI_FRAME_STRUCT>

protected

Definition at line 60 of file HSIEventSender.hpp.

Constructor & Destructor Documentation

HSIEventSender() [1/3]

dunedaq::hsilibs::HSIEventSender::HSIEventSender ( const std::string & name )

explicit

HSIEventSender Constructor.

Parameters

name	Instance name for this HSIEventSender instance

Definition at line 26 of file HSIEventSender.cpp.

  : dunedaq::appfwk::DAQModule(name)
  , m_hsievent_send_connection("")
  , m_queue_timeout(1)
  , m_hsievent_sender(nullptr)
  , m_sent_counter(0)
  , m_failed_to_send_counter(0)
  , m_last_sent_timestamp(0)
{
}

HSIEventSender() [2/3]

dunedaq::hsilibs::HSIEventSender::HSIEventSender ( const HSIEventSender & )

delete

HSIEventSender is not copy-constructible.

HSIEventSender() [3/3]

dunedaq::hsilibs::HSIEventSender::HSIEventSender ( HSIEventSender && )

delete

HSIEventSender is not move-constructible.

Member Function Documentation

do_configure()

virtual void dunedaq::hsilibs::HSIEventSender::do_configure ( const CommandData_t & obj )

protectedpure virtual

do_scrap()

virtual void dunedaq::hsilibs::HSIEventSender::do_scrap ( const CommandData_t & obj )

protectedpure virtual

do_start()

virtual void dunedaq::hsilibs::HSIEventSender::do_start ( const CommandData_t & obj )

protectedpure virtual

do_stop()

virtual void dunedaq::hsilibs::HSIEventSender::do_stop ( const CommandData_t & obj )

protectedpure virtual

init()

void dunedaq::hsilibs::HSIEventSender::init ( std::shared_ptr< appfwk::ConfigurationManager > mcfg )

override

Definition at line 38 of file HSIEventSender.cpp.

{
  auto mdal = mcfg->get_dal<confmodel::DaqModule>(get_name()); // Only need generic DaqModule for output
 
  if (!mdal) {
    throw appfwk::CommandFailed(ERS_HERE, "init", get_name(), "Unable to retrieve configuration object");
  }
 
  for (auto con : mdal->get_outputs()) {
    if (con->get_data_type() == datatype_to_string<dfmessages::HSIEvent>()) {
      m_hsievent_send_connection = con->UID();
    }
  }
 
  m_hsievent_sender = get_iom_sender<dfmessages::HSIEvent>(m_hsievent_send_connection);
}

operator=() [1/2]

HSIEventSender & dunedaq::hsilibs::HSIEventSender::operator= ( const HSIEventSender & )

delete

HSIEventSender is not copy-assignable.

operator=() [2/2]

HSIEventSender & dunedaq::hsilibs::HSIEventSender::operator= ( HSIEventSender && )

delete

HSIEventSender is not move-assignable.

ready_to_send()

bool dunedaq::hsilibs::HSIEventSender::ready_to_send ( std::chrono::milliseconds timeout )

protectedvirtual

Definition at line 56 of file HSIEventSender.cpp.

{
  if (m_hsievent_sender == nullptr) {
    return false;
  }
  return m_hsievent_sender->is_ready_for_sending(timeout);
}

send_hsi_event()

void dunedaq::hsilibs::HSIEventSender::send_hsi_event ( dfmessages::HSIEvent & event )

protectedvirtual

Definition at line 65 of file HSIEventSender.cpp.

{
  TLOG_DEBUG(3) << get_name() << ": Sending HSIEvent to " << m_hsievent_send_connection << ". \n"
                << event.header << ", " << std::bitset<32>(event.signal_map) << ", " << event.timestamp << ", "
                << event.sequence_counter << "\n";
 
  bool was_successfully_sent = false;
  while (!was_successfully_sent) {
    try {
      dfmessages::HSIEvent event_copy(event);
      m_hsievent_sender->send(std::move(event_copy), m_queue_timeout);
      ++m_sent_counter;
      m_last_sent_timestamp.store(event.timestamp);
      was_successfully_sent = true;
    } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
      std::ostringstream oss_warn;
      oss_warn << "push to output connection \"" << m_hsievent_send_connection << "\"";
      ers::error(dunedaq::iomanager::TimeoutExpired(ERS_HERE, get_name(), oss_warn.str(), m_queue_timeout.count()));
      ++m_failed_to_send_counter;
    }
  }
  if (m_sent_counter > 0 && m_sent_counter % 200000 == 0)
    TLOG_DEBUG(3) << "Have sent out " << m_sent_counter << " HSI events";
}

send_raw_hsi_data()

void dunedaq::hsilibs::HSIEventSender::send_raw_hsi_data ( const std::array< uint32_t, 7 > & raw_data, raw_sender_ct * sender )

protectedvirtual

Definition at line 91 of file HSIEventSender.cpp.

{
  HSI_FRAME_STRUCT payload;
  ::memcpy(&payload, &raw_data[0], sizeof(HSI_FRAME_STRUCT));
 
  TLOG_DEBUG(3) << get_name() << ": Sending HSI_FRAME_STRUCT " << std::hex << "0x" << payload.frame.version << ", 0x"
                << payload.frame.detector_id
 
                << "; 0x" << payload.frame.timestamp_low << "; 0x" << payload.frame.timestamp_high << "; 0x"
                << payload.frame.input_low << "; 0x" << payload.frame.input_high << "; 0x" << payload.frame.trigger
                << "; 0x" << payload.frame.sequence << std::endl;
 
  try {
    // TODO deal with this
    if (!sender) {
      throw(QueueIsNullFatalError(ERS_HERE, get_name(), "HSIEventSender output"));
    }
    sender->send(std::move(payload), m_queue_timeout);
  } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
    std::ostringstream oss_warn;
    oss_warn << "push to output raw hsi data queue failed";
    ers::error(dunedaq::iomanager::TimeoutExpired(ERS_HERE, get_name(), oss_warn.str(), m_queue_timeout.count()));
    ++m_failed_to_send_counter;
  }
}

Member Data Documentation

m_failed_to_send_counter

std::atomic<uint64_t> dunedaq::hsilibs::HSIEventSender::m_failed_to_send_counter

protected

Definition at line 71 of file HSIEventSender.hpp.

m_hsievent_send_connection

std::string dunedaq::hsilibs::HSIEventSender::m_hsievent_send_connection

protected

Definition at line 57 of file HSIEventSender.hpp.

m_hsievent_sender

std::shared_ptr<hsievent_sender_ct> dunedaq::hsilibs::HSIEventSender::m_hsievent_sender

protected

Definition at line 63 of file HSIEventSender.hpp.

m_last_sent_timestamp

std::atomic<uint64_t> dunedaq::hsilibs::HSIEventSender::m_last_sent_timestamp

protected

Definition at line 72 of file HSIEventSender.hpp.

m_queue_timeout

std::chrono::milliseconds dunedaq::hsilibs::HSIEventSender::m_queue_timeout

protected

Definition at line 58 of file HSIEventSender.hpp.

m_sent_counter

std::atomic<uint64_t> dunedaq::hsilibs::HSIEventSender::m_sent_counter

protected

Definition at line 70 of file HSIEventSender.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/hsilibs/include/hsilibs/HSIEventSender.hpp
• /github/workspace/dunedaq/sourcecode/hsilibs/src/HSIEventSender.cpp