rad 6.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
rad::cii::Requestor< INTERFACE_TYPE > Class Template Reference

#include <requestor.hpp>

Public Member Functions

 Requestor (const elt::mal::Uri &uri, const std::vector< std::shared_ptr< elt::mal::rr::qos::QoS > > &qos, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
 Requestor (const elt::mal::Uri &uri, const std::optional< elt::mal::Mal::Properties > mal_properties={})
 
std::shared_ptr< INTERFACE_TYPE > & GetInterface ()
 
 Requestor (const Requestor &)=delete
 
Requestoroperator= (const Requestor &)=delete
 

Detailed Description

template<typename INTERFACE_TYPE>
class rad::cii::Requestor< INTERFACE_TYPE >

This class can be used to send a request and receive the related reply using CII/MAL/ZPB middleware.

The constructor creates a MAL client that can be used to send the requests (see GetInterface method).

Constructor & Destructor Documentation

◆ Requestor() [1/3]

template<typename INTERFACE_TYPE >
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const elt::mal::Uri & uri,
const std::vector< std::shared_ptr< elt::mal::rr::qos::QoS > > & qos,
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.
qosQoS for message transmission (e.g. connection/reply timeouts).
mal_propertiesMAL properties for message transmission.

◆ Requestor() [2/3]

template<typename INTERFACE_TYPE >
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const elt::mal::Uri & uri,
const std::optional< elt::mal::Mal::Properties > mal_properties = {} )
inlineexplicit

This constructor creates a MAL Client for a given interface type using the default QoS.

It is needed for backward compatibility.

◆ Requestor() [3/3]

template<typename INTERFACE_TYPE >
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const Requestor< INTERFACE_TYPE > & )
delete

Member Function Documentation

◆ GetInterface()

template<typename INTERFACE_TYPE >
std::shared_ptr< INTERFACE_TYPE > & rad::cii::Requestor< INTERFACE_TYPE >::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_TYPE >
Requestor & rad::cii::Requestor< INTERFACE_TYPE >::operator= ( const Requestor< INTERFACE_TYPE > & )
delete

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