rad::cii::RequestAmi< REP_TYPE, void > Class Template Reference

#include <request.hpp>

Public Member Functions
	RequestAmi ()
	RequestAmi (const void &req_payload)
Default copy constructors.
	RequestAmi (const RequestAmi &)=default
	RequestAmi (RequestAmi &&) noexcept=default
Default copy constructors.
	RequestAmi (const RequestAmi &)=default
	RequestAmi (RequestAmi &&) noexcept(std::is_nothrow_move_constructible< void >())=default

Default assignment operators.
RequestAmi &	operator= (const RequestAmi &)=default
RequestAmi &	operator= (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 ()

Default assignment operators.
RequestAmi &	operator= (const RequestAmi &)=default
RequestAmi &	operator= (RequestAmi &&) noexcept(std::is_nothrow_move_assignable_v< void >)=default
const void &	GetRequestPayload () const
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_TYPE

Type of the reply's payload.

Constructor & Destructor Documentation

RequestAmi() [1/6]

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/6]

template<class REP_TYPE>

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

default

RequestAmi() [3/6]

template<class REP_TYPE>

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

defaultnoexcept

RequestAmi() [4/6]

rad::cii::RequestAmi< REP_TYPE, void >::RequestAmi ( const void & req_payload )

inlineexplicit

This constructor copies the payload associated to a MAL request and creates an AMI object for the MAL partial reply.

Parameters

req_payload

Payload associated to the MAL request.

Template Parameters

REQ_TYPE

Type of the payload associated to the MAL request.

RequestAmi() [5/6]

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

default

RequestAmi() [6/6]

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

defaultnoexcept

Member Function Documentation

GetAmiServer() [1/2]

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.

GetAmiServer() [2/2]

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.

GetRequestPayload()

const void & rad::cii::RequestAmi< REP_TYPE, void >::GetRequestPayload ( ) const

inline

operator=() [1/4]

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

default

operator=() [2/4]

template<class REP_TYPE>

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

default

operator=() [3/4]

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

defaultnoexcept

operator=() [4/4]

template<class REP_TYPE>

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

defaultnoexcept

SetFinalReplyValue() [1/2]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetFinalReplyValue() [2/2]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetPartialReplyValue() [1/2]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetPartialReplyValue() [2/2]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

---

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

• rad/cpp/mal/src/include/rad/mal/request.hpp