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
RequestAmi &	operator= (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
RequestAmi &	operator= (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
RequestAmi &	operator= (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_TYPE	Type of the reply's payload.
REQ_TYPE	Type of the request's payload (default is 'void').

Constructor & Destructor Documentation

RequestAmi() [1/6]

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_payload

Payload associated to the MAL request.

Template Parameters

REQ_TYPE

Type of the payload associated to the MAL request.

RequestAmi() [2/6]

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.

RequestAmi() [3/6]

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_payload

Payload associated to the MAL request.

Template Parameters

REQ_TYPE

Type of the payload associated to the MAL request.

RequestAmi() [4/6]

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.

RequestAmi() [5/6]

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_payload

Payload associated to the MAL request.

Template Parameters

REQ_TYPE

Type of the payload associated to the MAL request.

RequestAmi() [6/6]

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

GetAmiServer() [1/3]

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.

GetAmiServer() [2/3]

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.

GetAmiServer() [3/3]

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.

GetRequestPayload() [1/3]

template<typename REP_TYPE , typename REQ_TYPE = void>

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

inline

GetRequestPayload() [2/3]

template<typename REP_TYPE , typename REQ_TYPE = void>

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

inline

GetRequestPayload() [3/3]

template<typename REP_TYPE , typename REQ_TYPE = void>

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

inline

operator=() [1/3]

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.

operator=() [2/3]

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.

operator=() [3/3]

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.

SetFinalReplyValue() [1/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetFinalReplyValue() [2/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetFinalReplyValue() [3/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetPartialReplyValue() [1/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetPartialReplyValue() [2/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

SetPartialReplyValue() [3/3]

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

reply

Payload of the reply.

Returns

TODO not clear from CII documentation!

---

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

• INTROOT/include/rad/mal/request.hpp