rad 6.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
rad::cii::RequestAmi< REP_TYPE, void > Class Template Reference

#include <request.hpp>

Public Member Functions

 RequestAmi ()
 
Default copy constructors.
 RequestAmi (const RequestAmi &)=default
 
 RequestAmi (RequestAmi &&) noexcept=default
 

Default assignment operators.

RequestAmioperator= (const RequestAmi &)=default
 
RequestAmioperator= (RequestAmi &&) noexcept=default
 
bool SetPartialReplyValue (const REP_TYPE &reply) const
 
bool SetFinalReplyValue (const REP_TYPE &reply) const
 
std::shared_ptr<::elt::mal::rr::Ami< REP_TYPE > > GetAmiServer ()
 

Detailed Description

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

This class allows to deal with MAL requests WITHOUT payload that returns multiple (partial) replies.

Template Parameters
REP_TYPEType of the reply's payload.

Constructor & Destructor Documentation

◆ RequestAmi() [1/3]

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

Default constructor that creates an AMI object to send the partial replies.

◆ RequestAmi() [2/3]

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

◆ RequestAmi() [3/3]

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

Member Function Documentation

◆ GetAmiServer()

template<class REP_TYPE >
std::shared_ptr<::elt::mal::rr::Ami< REP_TYPE > > rad::cii::RequestAmi< REP_TYPE, void >::GetAmiServer ( )
inline

TODO when is this method needed?

Returns
A pointer to the AMI object which can be used to set the partial replies.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ SetFinalReplyValue()

template<class REP_TYPE >
bool rad::cii::RequestAmi< REP_TYPE, void >::SetFinalReplyValue ( const REP_TYPE & reply) const
inline

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

Parameters
replyPayload of the reply.
Returns
TODO not clear from CII documentation!

◆ SetPartialReplyValue()

template<class REP_TYPE >
bool rad::cii::RequestAmi< REP_TYPE, void >::SetPartialReplyValue ( const REP_TYPE & reply) const
inline

This method allows to set the payload for a partial reply.

Parameters
replyPayload of the reply.
Returns
TODO not clear from CII documentation!

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