DDS  ver. 3.5.3.8.g5fe284b
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
dds::tools_api::SBaseRequestImpl< TRequest, TResponse > Struct Template Reference

#include <ToolsProtocolCore.h>

Public Types

using response_t = TResponse
 
using request_t = TRequest
 
using responseVector_t = std::vector< response_t >
 
typedef std::shared_ptr< SBaseRequestImplptr_t
 
typedef std::function< void(const response_t &)> callbackResponse_t
 Callback function for a Response notification. More...
 
typedef std::function< void(const SProgressResponseData &)> callbackProgress_t
 Callback function for progress notifications. More...
 
typedef std::function< void(const SMessageResponseData &)> callbackMessage_t
 Callback function for message notifications. More...
 
typedef std::function< void()> callbackDone_t
 Callback function for a done notification. More...
 

Public Member Functions

void setResponseCallback (callbackResponse_t _callbackResponse)
 
void setProgressCallback (callbackProgress_t _callbackProgress)
 
void setMessageCallback (callbackMessage_t _callbackMessage)
 
void setDoneCallback (callbackDone_t _callbackDone)
 
void execResponseCallback (const response_t &_arg)
 For tests or internal use. More...
 
void execProgressCallback (const SProgressResponseData &_arg)
 
void execMessageCallback (const SMessageResponseData &_arg)
 
void execDoneCallback ()
 
const request_tgetRequest () const
 

Static Public Member Functions

static ptr_t makeRequest (const request_t &_request)
 

Protected Member Functions

 SBaseRequestImpl ()
 
 SBaseRequestImpl (const SBaseRequestImpl &)
 
uint64_t crc64 (const std::string &_str)
 

Member Typedef Documentation

◆ callbackDone_t

template<class TRequest , class TResponse >
typedef std::function<void()> dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::callbackDone_t

Callback function for a done notification.

◆ callbackMessage_t

template<class TRequest , class TResponse >
typedef std::function<void(const SMessageResponseData&)> dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::callbackMessage_t

Callback function for message notifications.

◆ callbackProgress_t

template<class TRequest , class TResponse >
typedef std::function<void(const SProgressResponseData&)> dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::callbackProgress_t

Callback function for progress notifications.

◆ callbackResponse_t

template<class TRequest , class TResponse >
typedef std::function<void(const response_t&)> dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::callbackResponse_t

Callback function for a Response notification.

◆ ptr_t

template<class TRequest , class TResponse >
typedef std::shared_ptr<SBaseRequestImpl> dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::ptr_t

◆ request_t

template<class TRequest , class TResponse >
using dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::request_t = TRequest

◆ response_t

template<class TRequest , class TResponse >
using dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::response_t = TResponse

◆ responseVector_t

template<class TRequest , class TResponse >
using dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::responseVector_t = std::vector<response_t>

Constructor & Destructor Documentation

◆ SBaseRequestImpl() [1/2]

template<class TRequest , class TResponse >
dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::SBaseRequestImpl ( )
inlineprotected

◆ SBaseRequestImpl() [2/2]

template<class TRequest , class TResponse >
dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::SBaseRequestImpl ( const SBaseRequestImpl< TRequest, TResponse > &  )
protected

Member Function Documentation

◆ crc64()

template<class TRequest , class TResponse >
uint64_t dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::crc64 ( const std::string &  _str)
inlineprotected

◆ execDoneCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::execDoneCallback ( )
inline

◆ execMessageCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::execMessageCallback ( const SMessageResponseData &  _arg)
inline

◆ execProgressCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::execProgressCallback ( const SProgressResponseData _arg)
inline

◆ execResponseCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::execResponseCallback ( const response_t _arg)
inline

For tests or internal use.

◆ getRequest()

template<class TRequest , class TResponse >
const request_t& dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::getRequest ( ) const
inline

◆ makeRequest()

template<class TRequest , class TResponse >
static ptr_t dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::makeRequest ( const request_t _request)
inlinestatic

◆ setDoneCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::setDoneCallback ( callbackDone_t  _callbackDone)
inline

◆ setMessageCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::setMessageCallback ( callbackMessage_t  _callbackMessage)
inline

◆ setProgressCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::setProgressCallback ( callbackProgress_t  _callbackProgress)
inline

◆ setResponseCallback()

template<class TRequest , class TResponse >
void dds::tools_api::SBaseRequestImpl< TRequest, TResponse >::setResponseCallback ( callbackResponse_t  _callbackResponse)
inline

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