rtctk::ddtServer::DdtForwarder Class Reference

Base class defining common interface for all DDT forwarders. More...

#include <ddtForwarder.hpp>

Inheritance diagram for rtctk::ddtServer::DdtForwarder:

Public Types
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
	DdtForwarder (const std::string &comp_id, const std::string &fwd_type, const std::string &fwd_id, ServiceContainer &services)
virtual	~DdtForwarder ()=default
const std::string &	GetId () const
	Get identifier of the forwarder unit.
State	GetState () const
	Get the state of the forwarder unit.
virtual void	Start ()=0
	Start the processing thread of the forwarder unit.
virtual void	Run ()=0
	Start publishing DDT streams.
virtual void	Idle ()=0
	Stop publishing DDT streams.
virtual void	Stop ()=0
	Stop the processing thread of the forwarder unit.
virtual void	Recover ()=0
	Stop the processing thread of the forwarder unit and clear errors.
virtual void	Update ()=0
	Reload dynamic configuration of the forwarder unit.
virtual void	CheckErrors ()=0
	Check for Errors, will rethrow errors thrown in the forwarder.

Protected Member Functions
virtual void	SetState (State state)
void	AssertState (const std::set< State > &states)

Protected Attributes
const std::map< State, std::string >	m_state_text
log4cplus::Logger &	m_logger

Detailed Description

Base class defining common interface for all DDT forwarders.

Member Typedef Documentation

OldbIf

using rtctk::ddtServer::DdtForwarder::OldbIf = rtctk::componentFramework::OldbIf

ServiceContainer

using rtctk::ddtServer::DdtForwarder::ServiceContainer = rtctk::componentFramework::ServiceContainer

Member Enumeration Documentation

State

enum class rtctk::ddtServer::DdtForwarder::State : uint8_t

strong

States a forwarder unit can be in.

Enumerator
STOPPED
STARTING
IDLE
RUNNING
ERROR

Constructor & Destructor Documentation

DdtForwarder()

rtctk::ddtServer::DdtForwarder::DdtForwarder ( const std::string & comp_id, const std::string & fwd_type, const std::string & fwd_id, ServiceContainer & services )

inline

~DdtForwarder()

virtual rtctk::ddtServer::DdtForwarder::~DdtForwarder ( )

virtualdefault

Member Function Documentation

AssertState()

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

inlineprotected

CheckErrors()

virtual void rtctk::ddtServer::DdtForwarder::CheckErrors ( )

pure virtual

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

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

GetId()

const std::string & rtctk::ddtServer::DdtForwarder::GetId ( ) const

inline

Get identifier of the forwarder unit.

GetState()

State rtctk::ddtServer::DdtForwarder::GetState ( ) const

inline

Get the state of the forwarder unit.

Idle()

virtual void rtctk::ddtServer::DdtForwarder::Idle ( )

pure virtual

Stop publishing DDT streams.

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

Recover()

virtual void rtctk::ddtServer::DdtForwarder::Recover ( )

pure virtual

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

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

Run()

virtual void rtctk::ddtServer::DdtForwarder::Run ( )

pure virtual

Start publishing DDT streams.

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

SetState()

virtual void rtctk::ddtServer::DdtForwarder::SetState ( State state )

inlineprotectedvirtual

Start()

virtual void rtctk::ddtServer::DdtForwarder::Start ( )

pure virtual

Start the processing thread of the forwarder unit.

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

Stop()

virtual void rtctk::ddtServer::DdtForwarder::Stop ( )

pure virtual

Stop the processing thread of the forwarder unit.

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

Update()

virtual void rtctk::ddtServer::DdtForwarder::Update ( )

pure virtual

Reload dynamic configuration of the forwarder unit.

Implemented in rtctk::ddtServer::IpcqDdtForwarder< FwdInfo, ReaderType >.

Member Data Documentation

m_logger

log4cplus::Logger& rtctk::ddtServer::DdtForwarder::m_logger

protected

m_state_text

const std::map<State, std::string> rtctk::ddtServer::DdtForwarder::m_state_text

protected

Initial value:

= {
        {State::STOPPED, "Stopped"},
        {State::STARTING, "Starting"},
        {State::IDLE, "Idle"},
        {State::RUNNING, "Running"},
        {State::ERROR, "Error"},
    }

---

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

• reusableComponents/ddtServer/src/include/rtctk/ddtServer/ddtForwarder.hpp