rad  4.0.0
Public Member Functions | List of all members
rad::cii::Request< REP_TYPE, void > Class Template Reference

#include <request.hpp>

Public Member Functions

 Request ()
 
Default copy constructor.
 Request (const Request &)=default
 
 Request (Request &&) noexcept=default
 

Default assignment operators.

Requestoperator= (const Request &)=default
 
Requestoperator= (Request &&) noexcept=default
 
elt::mal::future< REP_TYPE > GetReplyFuture () const
 
void SetReplyValue (const REP_TYPE &reply) const
 
template<class T >
void SetException (const T &e) const
 

Detailed Description

template<class REP_TYPE>
class rad::cii::Request< REP_TYPE, void >

This class allows to send a MAL reply to a request WITHOUT payload.

Template Parameters
REP_TYPEType of the reply's payload.

Constructor & Destructor Documentation

◆ Request() [1/3]

template<class REP_TYPE >
rad::cii::Request< REP_TYPE, void >::Request ( )
inline

Default constructor that creates a promise associated to the MAL reply.

◆ Request() [2/3]

template<class REP_TYPE >
rad::cii::Request< REP_TYPE, void >::Request ( const Request< REP_TYPE, void > &  )
default

◆ Request() [3/3]

template<class REP_TYPE >
rad::cii::Request< REP_TYPE, void >::Request ( Request< REP_TYPE, void > &&  )
defaultnoexcept

Member Function Documentation

◆ GetReplyFuture()

template<class REP_TYPE >
elt::mal::future<REP_TYPE> rad::cii::Request< REP_TYPE, void >::GetReplyFuture ( ) const
inline

This method can be used to get the 'future' indicating when a reply is ready to be sent.

Returns
A future associated to the reply.

◆ operator=() [1/2]

template<class REP_TYPE >
Request& rad::cii::Request< REP_TYPE, void >::operator= ( const Request< REP_TYPE, void > &  )
default

◆ operator=() [2/2]

template<class REP_TYPE >
Request& rad::cii::Request< REP_TYPE, void >::operator= ( Request< REP_TYPE, void > &&  )
defaultnoexcept

◆ SetException()

template<class REP_TYPE >
template<class T >
void rad::cii::Request< REP_TYPE, void >::SetException ( const T &  e) const
inline

This method allows to set the payload for an ERROR reply.

Template Parameters
TType of exception which should derive from elt::mal::MalException.
Parameters
eException containing error description.

◆ SetReplyValue()

template<class REP_TYPE >
void rad::cii::Request< REP_TYPE, void >::SetReplyValue ( const REP_TYPE &  reply) const
inline

This method allows to set the payload for the OK reply.

Parameters
replyPayload of the reply.

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