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::RequestAmi< REP_TYPE, REQ_TYPE > Class Template Reference

#include <request.hpp>

Public Member Functions

 RequestAmi (const REQ_TYPE &req_payload)
 
 RequestAmi (const RequestAmi &r)=default
 
RequestAmioperator= (const RequestAmi &r)=default
 
const REQ_TYPE & 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 ()
 
 RequestAmi (const REQ_TYPE &req_payload)
 
 RequestAmi (const RequestAmi &r)=default
 
RequestAmioperator= (const RequestAmi &r)=default
 
const REQ_TYPE & 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 ()
 
 RequestAmi (const REQ_TYPE &req_payload)
 
 RequestAmi (const RequestAmi &r)=default
 
RequestAmioperator= (const RequestAmi &r)=default
 
const REQ_TYPE & 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<typename REP_TYPE, typename REQ_TYPE = void>
class rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >

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

Template Parameters
REP_TYPEType of the reply's payload.
REQ_TYPEType of the request's payload (default is 'void').

Constructor & Destructor Documentation

template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const REQ_TYPE &  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_payloadPayload associated to the MAL request.
Template Parameters
REQ_TYPEType of the payload associated to the MAL request.
template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const RequestAmi< REP_TYPE, REQ_TYPE > &  r)
default

Default copy constructor.

template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const REQ_TYPE &  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_payloadPayload associated to the MAL request.
Template Parameters
REQ_TYPEType of the payload associated to the MAL request.
template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const RequestAmi< REP_TYPE, REQ_TYPE > &  r)
default

Default copy constructor.

template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const REQ_TYPE &  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_payloadPayload associated to the MAL request.
Template Parameters
REQ_TYPEType of the payload associated to the MAL request.
template<typename REP_TYPE , typename REQ_TYPE = void>
rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::RequestAmi ( const RequestAmi< REP_TYPE, REQ_TYPE > &  r)
default

Default copy constructor.

Member Function Documentation

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

TODO when is this method needed?

Returns
A pointer to the AMI object which can be used to set the partial replies.
template<typename REP_TYPE , typename REQ_TYPE = void>
std::shared_ptr<::elt::mal::rr::Ami<REP_TYPE> > rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::GetAmiServer ( )
inline

TODO when is this method needed?

Returns
A pointer to the AMI object which can be used to set the partial replies.
template<typename REP_TYPE , typename REQ_TYPE = void>
std::shared_ptr<::elt::mal::rr::Ami<REP_TYPE> > rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::GetAmiServer ( )
inline

TODO when is this method needed?

Returns
A pointer to the AMI object which can be used to set the partial replies.
template<typename REP_TYPE , typename REQ_TYPE = void>
const REQ_TYPE& rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::GetRequestPayload ( ) const
inline
template<typename REP_TYPE , typename REQ_TYPE = void>
const REQ_TYPE& rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::GetRequestPayload ( ) const
inline
template<typename REP_TYPE , typename REQ_TYPE = void>
const REQ_TYPE& rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::GetRequestPayload ( ) const
inline
template<typename REP_TYPE , typename REQ_TYPE = void>
RequestAmi& rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::operator= ( const RequestAmi< REP_TYPE, REQ_TYPE > &  r)
default

Default assignment operator.

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

Default assignment operator.

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

Default assignment operator.

template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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!
template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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!
template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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!
template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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!
template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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!
template<typename REP_TYPE , typename REQ_TYPE = void>
bool rad::cii::RequestAmi< REP_TYPE, REQ_TYPE >::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 files: