dunedaq::snbmodules::notification_type Struct Reference

#include <notification_enum.hpp>

Public Types
enum	e_notification_type {   CONNECTION_REQUEST , NEW_TRANSFER , UPDATE_REQUEST , GROUP_METADATA ,   TRANSFER_ERROR , START_TRANSFER , TRANSFER_METADATA , PAUSE_TRANSFER ,   RESUME_TRANSFER , CANCEL_TRANSFER }
	Different type of notifications possible to send. More...

Static Public Member Functions
static std::string	notification_to_string (e_notification_type e)
static std::optional< e_notification_type >	string_to_notification (std::string s)

Detailed Description

Definition at line 17 of file notification_enum.hpp.

Member Enumeration Documentation

e_notification_type

enum dunedaq::snbmodules::notification_type::e_notification_type

Different type of notifications possible to send.

Enumerator
CONNECTION_REQUEST
NEW_TRANSFER
UPDATE_REQUEST
GROUP_METADATA
TRANSFER_ERROR
START_TRANSFER
TRANSFER_METADATA
PAUSE_TRANSFER
RESUME_TRANSFER
CANCEL_TRANSFER

Definition at line 20 of file notification_enum.hpp.

  {
    // bookkeeper
    CONNECTION_REQUEST,
    NEW_TRANSFER,
    UPDATE_REQUEST,
 
    // client
    GROUP_METADATA,
    TRANSFER_ERROR,
 
    // both
    START_TRANSFER,
    TRANSFER_METADATA,
    PAUSE_TRANSFER,
    RESUME_TRANSFER,
    CANCEL_TRANSFER,
  };

Member Function Documentation

notification_to_string()

static std::string dunedaq::snbmodules::notification_type::notification_to_string ( e_notification_type e )

inlinestatic

Definition at line 39 of file notification_enum.hpp.

  {
    const std::map<e_notification_type, std::string> MyEnumStrings{
      { CONNECTION_REQUEST, "CONNECTION_REQUEST" }, { NEW_TRANSFER, "NEW_TRANSFER" },
      { UPDATE_REQUEST, "UPDATE_REQUEST" },         { GROUP_METADATA, "GROUP_METADATA" },
      { TRANSFER_ERROR, "TRANSFER_ERROR" },         { START_TRANSFER, "START_TRANSFER" },
      { TRANSFER_METADATA, "TRANSFER_METADATA" },   { PAUSE_TRANSFER, "PAUSE_TRANSFER" },
      { RESUME_TRANSFER, "RESUME_TRANSFER" },       { CANCEL_TRANSFER, "CANCEL_TRANSFER" }
    };
    auto it = MyEnumStrings.find(e);
    return it == MyEnumStrings.end() ? "Not supported" : it->second;
  }

string_to_notification()

static std::optional< e_notification_type > dunedaq::snbmodules::notification_type::string_to_notification ( std::string s )

inlinestatic

Definition at line 52 of file notification_enum.hpp.

  {
    const std::map<std::string, e_notification_type> MyStringsEnum{
      { "CONNECTION_REQUEST", CONNECTION_REQUEST }, { "NEW_TRANSFER", NEW_TRANSFER },
      { "UPDATE_REQUEST", UPDATE_REQUEST },         { "GROUP_METADATA", GROUP_METADATA },
      { "TRANSFER_ERROR", TRANSFER_ERROR },         { "START_TRANSFER", START_TRANSFER },
      { "TRANSFER_METADATA", TRANSFER_METADATA },   { "PAUSE_TRANSFER", PAUSE_TRANSFER },
      { "RESUME_TRANSFER", RESUME_TRANSFER },       { "CANCEL_TRANSFER", CANCEL_TRANSFER }
    };
    auto it = MyStringsEnum.find(s);
    if (it == MyStringsEnum.end()) {
      return std::nullopt;
    }
    return it->second;
  }

---

The documentation for this struct was generated from the following file:

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/common/notification_enum.hpp