ifw-sup  3.0.0-pre3
Public Member Functions | List of all members
sup::syssup::common::Dispatcher< INTERFACE > Class Template Reference

#include <subsys.hpp>

Public Member Functions

 Dispatcher (const elt::mal::Uri &uri, const int timeout=5000, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
void Update (const elt::mal::Uri &uri, const int timeout=5000, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
std::shared_ptr< INTERFACE > & GetInterface ()
 
 Dispatcher (const Dispatcher &)=delete
 
Dispatcheroperator= (const Dispatcher &)=delete
 

Detailed Description

template<typename INTERFACE>
class sup::syssup::common::Dispatcher< INTERFACE >

Class Dispatcher helps defining a MAL client for a given interface

Constructor & Destructor Documentation

◆ Dispatcher() [1/2]

template<typename INTERFACE >
sup::syssup::common::Dispatcher< INTERFACE >::Dispatcher ( const elt::mal::Uri &  uri,
const int  timeout = 5000,
const std::optional< elt::mal::Mal::Properties >  mal_properties = {} 
)
inline

This constructor gets a MAL Client for a given interface type and configure it with the provided server URI and QoS.

Parameters
uriServer URI.
timeoutrequest timeout
mal_propertiesQoS for message transmission.

◆ Dispatcher() [2/2]

template<typename INTERFACE >
sup::syssup::common::Dispatcher< INTERFACE >::Dispatcher ( const Dispatcher< INTERFACE > &  )
delete

Member Function Documentation

◆ GetInterface()

template<typename INTERFACE >
std::shared_ptr<INTERFACE>& sup::syssup::common::Dispatcher< INTERFACE >::GetInterface ( )
inline

This method can be used to send a request by invoking one of the methods provided by the MAL Client.

Returns
Pointer to MAL Client.

◆ operator=()

template<typename INTERFACE >
Dispatcher& sup::syssup::common::Dispatcher< INTERFACE >::operator= ( const Dispatcher< INTERFACE > &  )
delete

◆ Update()

template<typename INTERFACE >
void sup::syssup::common::Dispatcher< INTERFACE >::Update ( const elt::mal::Uri &  uri,
const int  timeout = 5000,
const std::optional< elt::mal::Mal::Properties >  mal_properties = {} 
)
inline

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