dunedaq::snbmodules::NotificationInterface Class Reference

#include <notification_interface.hpp>

Inheritance diagram for dunedaq::snbmodules::NotificationInterface:

Public Member Functions
	NotificationInterface (std::string connection_prefix="snbmodules", int timeout_send=10, int timeout_receive=100)
	NotificationInterface (std::vector< std::string > bk_conn, std::set< std::string > client_conn, const std::string &connection_prefix="snbmodules", int timeout_send=10, int timeout_receive=100)
virtual	~NotificationInterface ()=default
std::optional< NotificationData >	listen_for_notification (const std::string &id, const std::string &expected_from="", int timeout=-1, int tries=-1)
	Listen for a notification.
bool	send_notification (const notification_type::e_notification_type &notif, const std::string &src, const std::string &dst, const std::string &id_conn, const std::string &data="", int tries=-1)
	Send a notification during m_timeout_send ms.
virtual bool	action_on_receive_notification (NotificationData notif)=0
	Action to do when receiving a notification.
void	lookups_connections ()
	Get the list of every connections, must have the prefix first in the name of the connection and the name of the connection must be in the format: prefix.*bookkeeper.* or prefix.*client.*.
const std::vector< std::string > &	get_bookkeepers_conn () const
	Init the connection interface, Only used for standalone application.
const std::set< std::string > &	get_clients_conn () const

Private Attributes
std::vector< std::string >	m_bookkeepers_conn
	List of bookkeepers connections.
std::set< std::string >	m_clients_conn
	List of clients connections.
int	m_timeout_send = 10
	Timeout for sending a notification in ms.
int	m_timeout_receive = 100
	Timeout for receiving a notification in ms.
std::string	m_connection_prefix = "snbmodules"
	Prefix for the connection name.
int	m_max_tries = 3

Detailed Description

Definition at line 67 of file notification_interface.hpp.

Constructor & Destructor Documentation

NotificationInterface() [1/2]

dunedaq::snbmodules::NotificationInterface::NotificationInterface ( std::string connection_prefix = "snbmodules", int timeout_send = 10, int timeout_receive = 100 )

inlineexplicit

Definition at line 71 of file notification_interface.hpp.

    : m_timeout_send(timeout_send)
    , m_timeout_receive(timeout_receive)
    , m_connection_prefix(std::move(connection_prefix))
  {
  }

NotificationInterface() [2/2]

dunedaq::snbmodules::NotificationInterface::NotificationInterface ( std::vector< std::string > bk_conn, std::set< std::string > client_conn, const std::string & connection_prefix = "snbmodules", int timeout_send = 10, int timeout_receive = 100 )

inline

Definition at line 80 of file notification_interface.hpp.

    : m_timeout_send(timeout_send)
    , m_timeout_receive(timeout_receive)
    , m_connection_prefix(connection_prefix)
  {
    m_bookkeepers_conn = std::move(bk_conn);
    TLOG() << "CCC " << __LINE__ << " client_conn size=" << client_conn.size();
    m_clients_conn = std::move(client_conn);
  }

~NotificationInterface()

virtual dunedaq::snbmodules::NotificationInterface::~NotificationInterface ( )

virtualdefault

Member Function Documentation

action_on_receive_notification()

virtual bool dunedaq::snbmodules::NotificationInterface::action_on_receive_notification ( NotificationData notif )

pure virtual

Action to do when receiving a notification.

Parameters

notif

Notification received

Returns

true if the notification was handled, false otherwise

Implemented in dunedaq::snbmodules::Bookkeeper, dunedaq::snbmodules::TransferClient, and dunedaq::snbmodules::TransferSession.

get_bookkeepers_conn()

const std::vector< std::string > & dunedaq::snbmodules::NotificationInterface::get_bookkeepers_conn ( ) const

inline

Init the connection interface, Only used for standalone application.

Parameters

session_name	Name of the session
use_connectivity_service	Use the connectivity service
ip	IP of the connectivity service

Definition at line 189 of file notification_interface.hpp.

{ return m_bookkeepers_conn; }

get_clients_conn()

const std::set< std::string > & dunedaq::snbmodules::NotificationInterface::get_clients_conn ( ) const

inline

Definition at line 190 of file notification_interface.hpp.

{ return m_clients_conn; }

listen_for_notification()

std::optional< NotificationData > dunedaq::snbmodules::NotificationInterface::listen_for_notification	(	const std::string &	id,
		const std::string &	expected_from = "",
		int	timeout = -1,
		int	tries = -1 )

Listen for a notification.

Parameters

id	ID of the connection
expected_from	Expected source of the notification, if empty, accept any source
timeout	Timeout for receiving the notification in ms, if -1, use the default timeout

Returns

std::optional<NotificationData> Notification received or not

Definition at line 21 of file notification_interface.cpp.

{ // NOLINT
  // Default value for tries
  if (tries == -1) {
    tries = m_max_tries;
  }
  // TLOG() << "debug : Listening for request from " << id;
 
  if (timeout == -1) {
    timeout = m_timeout_receive;
  }
 
  TLOG() << "AAA " << __LINE__ << " getting receiver for UID \"" << id << "\"";
  std::optional<NotificationData> msg =
    iomanager::IOManager::get()->get_receiver<NotificationData>(id)->try_receive(std::chrono::milliseconds(timeout));
 
  if (msg.has_value()) {
    TLOG() << "debug : Received request " << msg->m_notification << " for " << msg->m_target_id;
 
    if (expected_from != "" && expected_from.find(msg.value().m_source_id) == std::string::npos) {
      TLOG() << "debug : Received request from " << msg->m_source_id << " but expected from " << expected_from
             << " ignoring";
      if (tries <= 1) {
        return std::nullopt;
      }
      tries--;
      return listen_for_notification(id, expected_from, timeout, tries);
    }
  }
  return msg;
}

lookups_connections()

void dunedaq::snbmodules::NotificationInterface::lookups_connections ( )

inline

Get the list of every connections, must have the prefix first in the name of the connection and the name of the connection must be in the format: prefix.*bookkeeper.* or prefix.*client.*.

Definition at line 126 of file notification_interface.hpp.

  {
 
    iomanager::ConnectionId id = { m_connection_prefix + ".*bookkeeper.*", "notification_t", "" };
    TLOG() << "LAB " << __LINE__ << " " << id.uid << " " << id.data_type << " " << id.session;
 
    try {
      iomanager::ConnectionResponse result = IOManagerWrapper::get().lookups_connection(id, false);
      for (const auto& conn : result.connections) {
        TLOG() << "CCC " << __LINE__ << " adding bookkeeper conn.uid=" << conn.uid;
        m_bookkeepers_conn.push_back(conn.uid);
      }
    } catch (...) // Ignore if no connection found
    {
      TLOG() << "LAB " << __LINE__;
    }
    try {
      id = { m_connection_prefix + ".*transfer.*", "notification_t", "" };
      TLOG() << "LAB " << __LINE__ << " " << id.uid << " " << id.data_type << " " << id.session;
      iomanager::ConnectionResponse result = IOManagerWrapper::get().lookups_connection(id, false);
      for (const auto& conn : result.connections) {
        TLOG() << "CCC " << __LINE__ << " adding transfer conn.uid=" << conn.uid;
        m_clients_conn.insert(conn.uid);
      }
    } catch (...) // Ignore if no connection found
    {
      TLOG() << "LAB " << __LINE__;
    }
  }

send_notification()

bool dunedaq::snbmodules::NotificationInterface::send_notification	(	const notification_type::e_notification_type &	notif,
		const std::string &	src,
		const std::string &	dst,
		const std::string &	id_conn,
		const std::string &	data = "",
		int	tries = -1 )

Send a notification during m_timeout_send ms.

Parameters

notif	Type of the notification
src	name of the source or uuid of the connection
dst	name of the destination or uuid of the connection
id_conn	ID of the connection
data	Data of the notification (optional)

Returns

Definition at line 57 of file notification_interface.cpp.

{
  // Default value for tries
  if (tries == -1) {
    tries = m_max_tries;
  }
 
  // find connection with dst in it
  std::string real_conn_id = id_conn;
  for (const auto& conn : m_bookkeepers_conn) {
    if (conn.find(id_conn) != std::string::npos) {
      real_conn_id = conn;
      break;
    }
  }
  for (const auto& conn : m_clients_conn) {
    if (conn.find(id_conn) != std::string::npos) {
      real_conn_id = conn;
      break;
    }
  }
 
  TLOG() << "debug : Sending request " << notification_type::notification_to_string(notif) << " to " << dst << " via "
         << real_conn_id;
 
  NotificationData notif_data(src, dst, notification_type::notification_to_string(notif), data);
 
  bool result = iomanager::IOManager::get()
                  ->get_sender<NotificationData>(real_conn_id)
                  ->try_send(std::move(notif_data), std::chrono::milliseconds(m_timeout_send));
 
  if (result == false) {
    ers::error(NotificationSendError(ERS_HERE, real_conn_id));
    if (tries <= 1) {
      return false;
    }
 
    // wait
    std::this_thread::sleep_for(std::chrono::milliseconds(m_timeout_send));
    TLOG() << "debug : Retrying send notification";
    tries--;
    return send_notification(notif, src, dst, real_conn_id, data, tries);
  }
 
  return result;
}

Member Data Documentation

m_bookkeepers_conn

std::vector<std::string> dunedaq::snbmodules::NotificationInterface::m_bookkeepers_conn

private

List of bookkeepers connections.

Definition at line 194 of file notification_interface.hpp.

m_clients_conn

std::set<std::string> dunedaq::snbmodules::NotificationInterface::m_clients_conn

private

List of clients connections.

Definition at line 196 of file notification_interface.hpp.

m_connection_prefix

std::string dunedaq::snbmodules::NotificationInterface::m_connection_prefix = "snbmodules"

private

Prefix for the connection name.

Definition at line 203 of file notification_interface.hpp.

m_max_tries

int dunedaq::snbmodules::NotificationInterface::m_max_tries = 3

private

Definition at line 205 of file notification_interface.hpp.

m_timeout_receive

int dunedaq::snbmodules::NotificationInterface::m_timeout_receive = 100

private

Timeout for receiving a notification in ms.

Definition at line 201 of file notification_interface.hpp.

m_timeout_send

int dunedaq::snbmodules::NotificationInterface::m_timeout_send = 10

private

Timeout for sending a notification in ms.

Definition at line 199 of file notification_interface.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/notification_interface.hpp
• /github/workspace/dunedaq/sourcecode/snbmodules/src/common/notification_interface.cpp