DDT Forwarder unit that ingests data from from SHM and republishes it on several DDT streams. More...

#include <ipcqDdtForwarder.hpp>

Inheritance diagram for rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >:

Public Types
using	Topic = typename FwdInfo::Topic

using	ServiceContainer = rtctk::componentFramework::ServiceContainer

using	RuntimeRepoIf = rtctk::componentFramework::RuntimeRepoIf

using	OldbIf = rtctk::componentFramework::OldbIf

using	ComponentMetricsIf = rtctk::componentFramework::ComponentMetricsIf

using	FrequencyEstimator = rtctk::componentFramework::FrequencyEstimator<>

using	DurationMonitor = rtctk::componentFramework::DurationMonitor<>

using	BufferMonitor = rtctk::componentFramework::BufferMonitor<>

Public Types inherited from rtctk::ddtServer::DdtForwarder
enum class	State : uint8_t { STOPPED , STARTING , IDLE , RUNNING , ERROR }
	States a forwarder unit can be in. More...

using	ServiceContainer = rtctk::componentFramework::ServiceContainer

using	OldbIf = rtctk::componentFramework::OldbIf

Public Member Functions
	IpcqDdtForwarder (const std::string &comp_id, ServiceContainer &services)

virtual	~IpcqDdtForwarder ()

void	Start () override
	Start the processing thread of the forwarder unit.

void	Run () override
	Start publishing DDT streams.

void	Idle () override
	Stop publishing DDT streams.

void	Stop () override
	Stop the processing thread of the forwarder unit.

void	Recover () override
	Stop the processing thread of the forwarder unit and clear errors.

void	Update () override
	Reload dynamic configuration of the forwarder unit.

void	CheckErrors () override
	Check for Errors, will rethrow errors thrown in the forwarder.

Public Member Functions inherited from rtctk::ddtServer::DdtForwarder
	DdtForwarder (const std::string &comp_id, const std::string &fwd_type, const std::string &fwd_id, ServiceContainer &services)

virtual	~DdtForwarder ()=default

std::string	GetId ()
	Get identifier of the forwarder unit.

State	GetState ()
	Get the state of the forwarder unit.

Additional Inherited Members
Protected Member Functions inherited from rtctk::ddtServer::DdtForwarder
virtual void	SetState (State state)

void	AssertState (const std::set< State > &states)

Protected Attributes inherited from rtctk::ddtServer::DdtForwarder
const std::map< State, std::string >	m_state_text

log4cplus::Logger &	m_logger

Detailed Description

template<typename FwdInfo, typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>
class rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >

DDT Forwarder unit that ingests data from from SHM and republishes it on several DDT streams.

Template Parameters

RecInfoType	RecordingInfo trait class for compile-time configuration.
ReaderType	class for unit-testing only.

Member Typedef Documentation

◆ BufferMonitor

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::BufferMonitor = rtctk::componentFramework::BufferMonitor<>

◆ ComponentMetricsIf

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::ComponentMetricsIf = rtctk::componentFramework::ComponentMetricsIf

◆ DurationMonitor

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::DurationMonitor = rtctk::componentFramework::DurationMonitor<>

◆ FrequencyEstimator

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::FrequencyEstimator = rtctk::componentFramework::FrequencyEstimator<>

◆ OldbIf

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::OldbIf = rtctk::componentFramework::OldbIf

◆ RuntimeRepoIf

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::RuntimeRepoIf = rtctk::componentFramework::RuntimeRepoIf

◆ ServiceContainer

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::ServiceContainer = rtctk::componentFramework::ServiceContainer

◆ Topic

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

using rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Topic = typename FwdInfo::Topic

Constructor & Destructor Documentation

◆ IpcqDdtForwarder()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::IpcqDdtForwarder	(	const std::string &	comp_id,
		ServiceContainer &	services )

inline

◆ ~IpcqDdtForwarder()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

virtual rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::~IpcqDdtForwarder ( )

inlinevirtual

Member Function Documentation

◆ CheckErrors()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::CheckErrors ( )

inlineoverridevirtual

Check for Errors, will rethrow errors thrown in the forwarder.

Implements rtctk::ddtServer::DdtForwarder.

◆ Idle()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Idle ( )

inlineoverridevirtual

Stop publishing DDT streams.

Implements rtctk::ddtServer::DdtForwarder.

◆ Recover()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Recover ( )

inlineoverridevirtual

Stop the processing thread of the forwarder unit and clear errors.

Implements rtctk::ddtServer::DdtForwarder.

◆ Run()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Run ( )

inlineoverridevirtual

Start publishing DDT streams.

Implements rtctk::ddtServer::DdtForwarder.

◆ Start()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Start ( )

inlineoverridevirtual

Start the processing thread of the forwarder unit.

Implements rtctk::ddtServer::DdtForwarder.

◆ Stop()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Stop ( )

inlineoverridevirtual

Stop the processing thread of the forwarder unit.

Implements rtctk::ddtServer::DdtForwarder.

◆ Update()

template<typename FwdInfo , typename ReaderType = ipcq::Reader<typename FwdInfo::Topic>>

void rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >::Update ( )

inlineoverridevirtual

Reload dynamic configuration of the forwarder unit.

Implements rtctk::ddtServer::DdtForwarder.

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

reusableComponents/ddtServer/src/include/rtctk/ddtServer/ipcqDdtForwarder.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BufferMonitor

◆ ComponentMetricsIf

◆ DurationMonitor

◆ FrequencyEstimator

◆ OldbIf

◆ RuntimeRepoIf

◆ ServiceContainer

◆ Topic

Constructor & Destructor Documentation

◆ IpcqDdtForwarder()

◆ ~IpcqDdtForwarder()

Member Function Documentation

◆ CheckErrors()

◆ Idle()

◆ Recover()

◆ Run()

◆ Start()

◆ Stop()

◆ Update()