dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType > Class Template Reference

#include <RequestHandlerConcept.hpp>

Inheritance diagram for dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >:

Collaboration diagram for dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >:

Classes
struct	RequestResult

Public Member Functions
	RequestHandlerConcept ()
virtual	~RequestHandlerConcept ()
	RequestHandlerConcept (const RequestHandlerConcept &)=delete
	RequestHandlerConcept is not copy-constructible.
RequestHandlerConcept &	operator= (const RequestHandlerConcept &)=delete
	RequestHandlerConcept is not copy-assginable.
	RequestHandlerConcept (RequestHandlerConcept &&)=delete
	RequestHandlerConcept is not move-constructible.
RequestHandlerConcept &	operator= (RequestHandlerConcept &&)=delete
	RequestHandlerConcept is not move-assignable.
virtual void	conf (const appmodel::DataHandlerModule *conf)=0
virtual void	scrap (const nlohmann::json &args)=0
virtual void	start (const nlohmann::json &args)=0
virtual void	stop (const nlohmann::json &args)=0
virtual void	record (const nlohmann::json &args)=0
virtual void	cleanup_check ()=0
	Check if cleanup is necessary and execute it if necessary.
virtual void	periodic_data_transmission ()=0
	Periodic data transmission - relevant for trigger in particular.
virtual void	issue_request (dfmessages::DataRequest, bool)=0
	Issue a data request to the request handler.
Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject (const MonitorableObject &)=delete
MonitorableObject &	operator= (const MonitorableObject &)=delete
	MonitorableObject (MonitorableObject &&)=delete
MonitorableObject &	operator= (MonitorableObject &&)=delete
virtual	~MonitorableObject ()=default
auto	get_opmon_id () const noexcept
auto	get_opmon_level () const noexcept

Protected Types
enum	ResultCode {   kFound = 0 , kNotFound , kTooOld , kNotYet ,   kPartial , kPartiallyOld , kCleanup , kUnknown }

Protected Member Functions
const std::string &	resultCodeAsString (ResultCode rc)
virtual void	cleanup ()=0
virtual RequestResult	data_request (dfmessages::DataRequest)=0
Protected Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject ()=default
void	register_node (ElementId name, NewNodePtr)
void	publish (google::protobuf::Message &&, CustomOrigin &&co={}, OpMonLevel l=to_level(EntryOpMonLevel::kDefault)) const noexcept
virtual void	generate_opmon_data ()

Protected Attributes
std::map< ResultCode, std::string >	ResultCodeStrings

Additional Inherited Members
Public Types inherited from dunedaq::opmonlib::MonitorableObject
using	NodePtr = std::weak_ptr<MonitorableObject>
using	NewNodePtr = std::shared_ptr<MonitorableObject>
using	ElementId = std::string
Static Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
static bool	publishable_metric (OpMonLevel entry, OpMonLevel system) noexcept

Detailed Description

template<class ReadoutType, class LatencyBufferType>
class dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >

Definition at line 26 of file RequestHandlerConcept.hpp.

Member Enumeration Documentation

ResultCode

template<class ReadoutType , class LatencyBufferType >

enum dunedaq::datahandlinglibs::RequestHandlerConcept::ResultCode

protected

Enumerator
kFound
kNotFound
kTooOld
kNotYet
kPartial
kPartiallyOld
kCleanup
kUnknown

Definition at line 59 of file RequestHandlerConcept.hpp.

  {
    kFound = 0,
    kNotFound,
    kTooOld,
    kNotYet,
    kPartial,
    kPartiallyOld,
    kCleanup,
    kUnknown
  };

Constructor & Destructor Documentation

RequestHandlerConcept() [1/3]

template<class ReadoutType , class LatencyBufferType >

dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::RequestHandlerConcept ( )

inline

Definition at line 30 of file RequestHandlerConcept.hpp.

{}

~RequestHandlerConcept()

template<class ReadoutType , class LatencyBufferType >

virtual dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::~RequestHandlerConcept ( )

inlinevirtual

Definition at line 32 of file RequestHandlerConcept.hpp.

{}

RequestHandlerConcept() [2/3]

template<class ReadoutType , class LatencyBufferType >

dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::RequestHandlerConcept ( const RequestHandlerConcept< ReadoutType, LatencyBufferType > & )

delete

RequestHandlerConcept is not copy-constructible.

RequestHandlerConcept() [3/3]

template<class ReadoutType , class LatencyBufferType >

dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::RequestHandlerConcept ( RequestHandlerConcept< ReadoutType, LatencyBufferType > && )

delete

RequestHandlerConcept is not move-constructible.

Member Function Documentation

cleanup()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::cleanup ( )

protectedpure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, dunedaq::datahandlinglibs::DefaultSkipListRequestHandler< T >, dunedaq::datahandlinglibs::DefaultSkipListRequestHandler< TriggerPrimitiveTypeAdapter >, and dunedaq::fdreadoutlibs::DAPHNEListRequestHandler.

cleanup_check()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::cleanup_check ( )

pure virtual

Check if cleanup is necessary and execute it if necessary.

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, and dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >.

conf()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::conf ( const appmodel::DataHandlerModule * conf )

pure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, dunedaq::datahandlinglibs::ZeroCopyRecordingRequestHandlerModel< ReadoutType, LatencyBufferType >, and dunedaq::trigger::TPRequestHandler.

data_request()

template<class ReadoutType , class LatencyBufferType >

virtual RequestResult dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::data_request ( dfmessages::DataRequest )

protectedpure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, and dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >.

issue_request()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::issue_request ( dfmessages::DataRequest , bool  )

pure virtual

Issue a data request to the request handler.

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, and dunedaq::datahandlinglibs::EmptyFragmentRequestHandlerModel< ReadoutType, LatencyBufferType >.

operator=() [1/2]

template<class ReadoutType , class LatencyBufferType >

RequestHandlerConcept & dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::operator= ( const RequestHandlerConcept< ReadoutType, LatencyBufferType > & )

delete

RequestHandlerConcept is not copy-assginable.

operator=() [2/2]

template<class ReadoutType , class LatencyBufferType >

RequestHandlerConcept & dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::operator= ( RequestHandlerConcept< ReadoutType, LatencyBufferType > && )

delete

RequestHandlerConcept is not move-assignable.

periodic_data_transmission()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::periodic_data_transmission ( )

pure virtual

Periodic data transmission - relevant for trigger in particular.

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, and dunedaq::trigger::TPRequestHandler.

record()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::record ( const nlohmann::json & args )

pure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, and dunedaq::datahandlinglibs::ZeroCopyRecordingRequestHandlerModel< ReadoutType, LatencyBufferType >.

resultCodeAsString()

template<class ReadoutType , class LatencyBufferType >

const std::string & dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::resultCodeAsString ( ResultCode rc )

inlineprotected

Definition at line 77 of file RequestHandlerConcept.hpp.

{ return ResultCodeStrings[rc]; }

scrap()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::scrap ( const nlohmann::json & args )

pure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, and dunedaq::trigger::TPRequestHandler.

start()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::start ( const nlohmann::json & args )

pure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >, and dunedaq::trigger::TPRequestHandler.

stop()

template<class ReadoutType , class LatencyBufferType >

virtual void dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::stop ( const nlohmann::json & args )

pure virtual

Implemented in dunedaq::datahandlinglibs::DefaultRequestHandlerModel< ReadoutType, LatencyBufferType >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< T, datahandlinglibs::SkipListLatencyBufferModel< T > >, dunedaq::datahandlinglibs::DefaultRequestHandlerModel< TriggerPrimitiveTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< TriggerPrimitiveTypeAdapter > >, and dunedaq::datahandlinglibs::DefaultRequestHandlerModel< types::DAPHNESuperChunkTypeAdapter, datahandlinglibs::SkipListLatencyBufferModel< types::DAPHNESuperChunkTypeAdapter > >.

Member Data Documentation

ResultCodeStrings

template<class ReadoutType , class LatencyBufferType >

std::map<ResultCode, std::string> dunedaq::datahandlinglibs::RequestHandlerConcept< ReadoutType, LatencyBufferType >::ResultCodeStrings

protected

Initial value:

{
    { ResultCode::kFound, "FOUND" },    { ResultCode::kNotFound, "NOT_FOUND" },
    { ResultCode::kTooOld, "TOO_OLD" }, { ResultCode::kNotYet, "NOT_YET_PRESENT" },
    { ResultCode::kPartiallyOld, "PARTIALLY_PASSED" },    { ResultCode::kCleanup, "CLEANUP" },
    { ResultCode::kUnknown, "UNKNOWN" }
  }

Definition at line 70 of file RequestHandlerConcept.hpp.

                                                 {
    { ResultCode::kFound, "FOUND" },    { ResultCode::kNotFound, "NOT_FOUND" },
    { ResultCode::kTooOld, "TOO_OLD" }, { ResultCode::kNotYet, "NOT_YET_PRESENT" },
    { ResultCode::kPartiallyOld, "PARTIALLY_PASSED" },    { ResultCode::kCleanup, "CLEANUP" },
    { ResultCode::kUnknown, "UNKNOWN" }
  };

---

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

• /github/workspace/dunedaq/sourcecode/datahandlinglibs/include/datahandlinglibs/concepts/RequestHandlerConcept.hpp