rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE > Class Template Reference

#include <smSubscriber.hpp>

Inheritance diagram for rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >:

Public Member Functions
	SMSubscriber (const elt::mal::Uri &uri, SMAdapter &sm, const std::optional< elt::mal::Mal::Properties > mal_properties={})
void	Callback (elt::mal::ps::Subscriber< TOPIC_TYPE > &subscriber, const elt::mal::ps::DataEvent< TOPIC_TYPE > &event)
	SMSubscriber (const SMSubscriber &)=delete
SMSubscriber &	operator= (const SMSubscriber &)=delete
Public Member Functions inherited from rad::cii::Subscriber< TOPIC_TYPE >
	Subscriber (const elt::mal::Uri &uri, TopicHandler_t handler, const std::optional< elt::mal::Mal::Properties > mal_properties={})
	Subscriber (const Subscriber &)=delete
Subscriber &	operator= (const Subscriber &)=delete
	Subscriber (Subscriber &&rhs)=default

Additional Inherited Members
Public Types inherited from rad::cii::Subscriber< TOPIC_TYPE >
using	TopicHandler_t

Detailed Description

template<typename TOPIC_TYPE, typename EVENT_TYPE>
class rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >

This class allows to subscribe to a topic of a given type and, upon reception inject an event of type EVENT_TYPE into to the State Machine engine. The payload of the event is the same as the payload of the topic.

Template Parameters

TOPIC_TYPE	Type of the topic that can be subscribed to.
EVENT_TYPE	Type of the event to be triggered upon the reception of the topic.

Constructor & Destructor Documentation

SMSubscriber() [1/2]

template<typename TOPIC_TYPE , typename EVENT_TYPE >

rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >::SMSubscriber ( const elt::mal::Uri & uri, SMAdapter & sm, const std::optional< elt::mal::Mal::Properties > mal_properties = {} )

inline

This constructor allows to register an event to be triggered every time a given topic is received.

Parameters

uri	URI associated to the topic.
sm	Reference to State Machine engine.
mal_properties	QoS for message reception.

SMSubscriber() [2/2]

template<typename TOPIC_TYPE , typename EVENT_TYPE >

rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >::SMSubscriber ( const SMSubscriber< TOPIC_TYPE, EVENT_TYPE > & )

delete

Member Function Documentation

Callback()

template<typename TOPIC_TYPE , typename EVENT_TYPE >

void rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >::Callback ( elt::mal::ps::Subscriber< TOPIC_TYPE > & subscriber, const elt::mal::ps::DataEvent< TOPIC_TYPE > & event )

inline

operator=()

template<typename TOPIC_TYPE , typename EVENT_TYPE >

SMSubscriber & rad::SMSubscriber< TOPIC_TYPE, EVENT_TYPE >::operator= ( const SMSubscriber< TOPIC_TYPE, EVENT_TYPE > & )

delete

---

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

• rad/cpp/sm/src/include/rad/smSubscriber.hpp