daq::DpmClientImpl Class Reference

#include <dpmClient.hpp>

Inheritance diagram for daq::DpmClientImpl:

Classes
struct	Subscriptions

Public Types
using	StorageSignal = DpmClient::StorageSignal
	Retry delay when requesting status.
using	StatusSignal = DpmClient::StatusSignal
Public Types inherited from daq::DpmClient
using	StorageSignal = boost::signals2::signal< void(std::filesystem::space_info)>
using	StatusSignal = boost::signals2::signal< void(Status)>

Public Member Functions
	DpmClientImpl (boost::asio::io_context &io_ctx, mal::Mal &mal, DpmClientParams params)
	~DpmClientImpl ()
virtual auto	ScheduleAsync (std::string const &spec, std::optional< std::string > const &status) -> boost::future< State > override
	Schedule merging.
virtual auto	AbortAsync (std::string const &id) -> boost::future< State > override
	Abort merging.
virtual void	StartMonitorStatus (std::string const &id) override
	Start monitoring DAQ status.
virtual void	StopMonitorStatus (std::string const &id) override
	Stop monitoring DAQ status.
virtual auto	ConnectStatusSignal (StatusSignal::slot_type const &slot) -> boost::signals2::connection override
	Connect slot to status change signal.
virtual auto	ConnectStorageSignal (StorageSignal::slot_type const &slot) -> boost::signals2::connection override
	Connect slot to storage change signal.
virtual auto	ScheduleAsync (std::string const &spec, std::optional< std::string > const &status) -> boost::future< State >=0
	Schedule merging.
virtual auto	AbortAsync (std::string const &id) -> boost::future< State >=0
	Abort merging.
virtual void	StartMonitorStatus (std::string const &id)=0
	Start monitoring DAQ status.
virtual void	StopMonitorStatus (std::string const &id)=0
	Stop monitoring DAQ status.
virtual auto	ConnectStatusSignal (StatusSignal::slot_type const &slot) -> boost::signals2::connection=0
	Connect slot to status change signal.
virtual auto	ConnectStorageSignal (StorageSignal::slot_type const &slot) -> boost::signals2::connection=0
	Connect slot to storage change signal.

Detailed Description

Definition at line 100 of file dpmClient.hpp.

---

Class Documentation

daq::DpmClientImpl::Subscriptions

struct daq::DpmClientImpl::Subscriptions

Definition at line 25 of file dpmClient.cpp.

Class Members
shared_ptr< bool >	alive = std::make_shared<bool>(true)
Subscription< InternalDaqStatus >	status
Subscription< StorageStatus >	storage

Member Typedef Documentation

StatusSignal

using daq::DpmClientImpl::StatusSignal = DpmClient::StatusSignal

Definition at line 106 of file dpmClient.hpp.

StorageSignal

using daq::DpmClientImpl::StorageSignal = DpmClient::StorageSignal

Retry delay when requesting status.

Definition at line 105 of file dpmClient.hpp.

Constructor & Destructor Documentation

DpmClientImpl()

daq::DpmClientImpl::DpmClientImpl	(	boost::asio::io_context &	io_ctx,
		mal::Mal &	mal,
		DpmClientParams	params
	)

Definition at line 31 of file dpmClient.cpp.

~DpmClientImpl()

daq::DpmClientImpl::~DpmClientImpl ( )

default

Member Function Documentation

AbortAsync()

auto daq::DpmClientImpl::AbortAsync ( std::string const &  id ) -> boost::future<State>

overridevirtual

Abort merging.

Implements daq::DpmClient.

Definition at line 108 of file dpmClient.cpp.

ConnectStatusSignal()

auto daq::DpmClientImpl::ConnectStatusSignal ( StatusSignal::slot_type const &  slot ) -> boost::signals2::connection

overridevirtual

Connect slot to status change signal.

DpmClient ensures that signals are only emitted from main thread.

Note

Status may come from different sources and no total order is guaranteed. Observers of status changes should make effort to discard/ignore changes that occurred before already recorded status updated.

Implements daq::DpmClient.

Definition at line 201 of file dpmClient.cpp.

ConnectStorageSignal()

auto daq::DpmClientImpl::ConnectStorageSignal ( StorageSignal::slot_type const &  slot ) -> boost::signals2::connection

overridevirtual

Connect slot to storage change signal.

DpmClient ensures that signals are only emitted from main thread.

Implements daq::DpmClient.

Definition at line 206 of file dpmClient.cpp.

ScheduleAsync()

auto daq::DpmClientImpl::ScheduleAsync ( std::string const &  spec, std::optional< std::string > const &  status  ) -> boost::future<State>

overridevirtual

Schedule merging.

Implements daq::DpmClient.

Definition at line 97 of file dpmClient.cpp.

StartMonitorStatus()

void daq::DpmClientImpl::StartMonitorStatus ( std::string const &  id )

overridevirtual

Start monitoring DAQ status.

Status is requested:

• Initially
• and rescheduled if reply times out (DPM not running)

Changes are reported via the StatusSignal.

Implements daq::DpmClient.

Definition at line 117 of file dpmClient.cpp.

StopMonitorStatus()

void daq::DpmClientImpl::StopMonitorStatus ( std::string const &  id )

overridevirtual

Stop monitoring DAQ status.

Implements daq::DpmClient.

Definition at line 197 of file dpmClient.cpp.

---

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

• common/libdaq/src/include/daq/dpmClient.hpp
• common/libdaq/src/dpmClient.cpp