rad  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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::optional< elt::mal::Mal::Properties > mal_properties={})
 
std::shared_ptr< INTERFACE_TYPE > & GetInterface ()
 
 Requestor (const Requestor &)=delete
 
Requestoroperator= (const Requestor &)=delete
 
 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
 
 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

template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const elt::mal::Uri &  uri,
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.
mal_propertiesQoS for message transmission.
template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const Requestor< INTERFACE_TYPE > &  )
delete
template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const elt::mal::Uri &  uri,
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.
mal_propertiesQoS for message transmission.
template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const Requestor< INTERFACE_TYPE > &  )
delete
template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const elt::mal::Uri &  uri,
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.
mal_propertiesQoS for message transmission.
template<typename INTERFACE_TYPE>
rad::cii::Requestor< INTERFACE_TYPE >::Requestor ( const Requestor< INTERFACE_TYPE > &  )
delete

Member Function Documentation

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