dunedaq::iomanager::QueueSenderModel< Datatype > Class Template Reference

#include <QueueSenderModel.hpp>

Inheritance diagram for dunedaq::iomanager::QueueSenderModel< Datatype >:

Collaboration diagram for dunedaq::iomanager::QueueSenderModel< Datatype >:

Public Member Functions
	QueueSenderModel (ConnectionId const &request)
	QueueSenderModel (QueueSenderModel &&other)
void	send (Datatype &&data, Sender::timeout_t timeout) override
bool	try_send (Datatype &&data, Sender::timeout_t timeout) override
void	send_with_topic (Datatype &&data, Sender::timeout_t timeout, std::string) override
bool	is_ready_for_sending (Sender::timeout_t timeout) override
Public Member Functions inherited from dunedaq::iomanager::SenderConcept< Datatype >
	SenderConcept (ConnectionId const &conn_id)
Public Member Functions inherited from dunedaq::iomanager::Sender
	Sender (ConnectionId const &this_conn)
virtual	~Sender ()=default
ConnectionId	id () const
Public Member Functions inherited from dunedaq::utilities::NamedObject
	NamedObject (const std::string &name)
	NamedObject Constructor.
	NamedObject (NamedObject const &)=delete
	NamedObject is not copy-constructible.
	NamedObject (NamedObject &&)=default
	NamedObject is move-constructible.
NamedObject &	operator= (NamedObject const &)=delete
	NamedObject is not copy-assignable.
NamedObject &	operator= (NamedObject &&)=default
	NamedObject is move-assignable.
virtual	~NamedObject ()=default
	Default virtual destructor.
const std::string &	get_name () const final
	Get the name of this NamedObejct.
Public Member Functions inherited from dunedaq::utilities::Named
	Named ()=default
	Named Constructor.
	Named (Named const &)=delete
	Named is not copy-constructible.
	Named (Named &&)=default
	Named is move-constructible.
Named &	operator= (Named const &)=delete
	Named is not copy-assignable.
Named &	operator= (Named &&)=default
	Named is move-assignable.
virtual	~Named ()=default
	Default virtual destructor.

Private Attributes
std::shared_ptr< Queue< Datatype > >	m_queue

Additional Inherited Members
Public Types inherited from dunedaq::iomanager::Sender
using	timeout_t = std::chrono::milliseconds
Static Public Attributes inherited from dunedaq::iomanager::Sender
static constexpr timeout_t	s_block = timeout_t::max()
static constexpr timeout_t	s_no_block = timeout_t::zero()
Protected Attributes inherited from dunedaq::iomanager::Sender
ConnectionId	m_conn

Detailed Description

template<typename Datatype>
class dunedaq::iomanager::QueueSenderModel< Datatype >

Definition at line 21 of file QueueSenderModel.hpp.

Constructor & Destructor Documentation

QueueSenderModel() [1/2]

template<typename Datatype >

dunedaq::iomanager::QueueSenderModel< Datatype >::QueueSenderModel ( ConnectionId const & request )

inlineexplicit

Definition at line 65 of file QueueSenderModel.hxx.

  : SenderConcept<Datatype>(request)
{
  TLOG("QueueSenderModel") << "QueueSenderModel created with DT! Addr: " << static_cast<void*>(this);
  m_queue = QueueRegistry::get().get_queue<Datatype>(request.uid);
  TLOG("QueueSenderModel") << "QueueSenderModel m_queue=" << static_cast<void*>(m_queue.get());
  // get queue ref from queueregistry based on conn_id
}

QueueSenderModel() [2/2]

template<typename Datatype >

dunedaq::iomanager::QueueSenderModel< Datatype >::QueueSenderModel ( QueueSenderModel< Datatype > && other )

inline

Definition at line 58 of file QueueSenderModel.hxx.

  : SenderConcept<Datatype>(other.m_conn.uid)
  , m_queue(std::move(other.m_queue))
{
}

Member Function Documentation

is_ready_for_sending()

template<typename Datatype >

bool dunedaq::iomanager::QueueSenderModel< Datatype >::is_ready_for_sending ( Sender::timeout_t timeout )

inlineoverridevirtual

Implements dunedaq::iomanager::SenderConcept< Datatype >.

Definition at line 51 of file QueueSenderModel.hxx.

{
  // Queues are always ready
  return true;
}

send()

template<typename Datatype >

void dunedaq::iomanager::QueueSenderModel< Datatype >::send ( Datatype && data, Sender::timeout_t timeout )

inlineoverridevirtual

Implements dunedaq::iomanager::SenderConcept< Datatype >.

Definition at line 37 of file QueueSenderModel.hxx.

{
  if (m_queue == nullptr)
    throw ConnectionInstanceNotFound(ERS_HERE, this->id().uid);
 
  try {
    m_queue->push(std::move(data), timeout);
  } catch (QueueTimeoutExpired& ex) {
    throw TimeoutExpired(ERS_HERE, this->id().uid, "push", timeout.count(), ex);
  }
}

send_with_topic()

template<typename Datatype >

void dunedaq::iomanager::QueueSenderModel< Datatype >::send_with_topic ( Datatype && data, Sender::timeout_t timeout, std::string  )

inlineoverridevirtual

Implements dunedaq::iomanager::SenderConcept< Datatype >.

Definition at line 17 of file QueueSenderModel.hxx.

{
  // Topics are not used for Queues
  send(std::move(data), timeout);
}

try_send()

template<typename Datatype >

bool dunedaq::iomanager::QueueSenderModel< Datatype >::try_send ( Datatype && data, Sender::timeout_t timeout )

inlineoverridevirtual

Implements dunedaq::iomanager::SenderConcept< Datatype >.

Definition at line 25 of file QueueSenderModel.hxx.

{
  if (m_queue == nullptr) {
    ers::error(ConnectionInstanceNotFound(ERS_HERE, this->id().uid));
    return false;
  }
 
  return m_queue->try_push(std::move(data), timeout);
}

Member Data Documentation

m_queue

template<typename Datatype >

std::shared_ptr<Queue<Datatype> > dunedaq::iomanager::QueueSenderModel< Datatype >::m_queue

private

Definition at line 37 of file QueueSenderModel.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/iomanager/include/iomanager/queue/QueueSenderModel.hpp
• /github/workspace/dunedaq/sourcecode/iomanager/include/iomanager/queue/detail/QueueSenderModel.hxx