ignition::transport::ReqHandler< Req, Rep > Class Template Reference

It creates a reply handler for the specific protobuf messages used. More...

#include <ReqHandler.hh>

Inheritance diagram for ignition::transport::ReqHandler< Req, Rep >:

Public Member Functions
	ReqHandler (const std::string &_nUuid)
std::shared_ptr< Rep >	CreateMsg (const std::string &_data) const
	Create a specific protobuf message given its serialized data. More...
void	NotifyResult (const std::string &_rep, const bool _result)
	Executes the callback registered for this handler and notify a potential requester waiting on a blocking call. More...
virtual std::string	RepTypeName () const
	Get the message type name used in the service response. More...
virtual std::string	ReqTypeName () const
	Get the message type name used in the service request. More...
bool	Serialize (std::string &_buffer) const
	Serialize the Req protobuf message stored. More...
void	SetCallback (const std::function< void(const Rep &_rep, const bool _result)> &_cb)
	Set the callback for this handler. More...
void	SetMessage (const Req *_reqMsg)
	Set the REQ protobuf message for this handler. More...
void	SetResponse (const Rep *)
	This function is only used for compatibility with SetResponse() when [REP = google::protobuf::Message]. More...
Public Member Functions inherited from ignition::transport::IReqHandler
	IReqHandler (const std::string &_nUuid)
	Constructor. More...
virtual	~IReqHandler ()=default
	Destructor. More...
std::string	HandlerUuid () const
	Returns the unique handler UUID. More...
std::string	NodeUuid () const
	Get the node UUID. More...
bool	Requested () const
	Returns if this service call request has already been requested. More...
void	Requested (const bool _value)
	Mark the service call as requested (or not). More...
std::string	Response () const
	Get the service response as raw bytes. More...
bool	Result () const
	Get the result of the service response. More...
template<typename Lock >
bool	WaitUntil (Lock &_lock, const unsigned int _timeout)
	Block the current thread until the response to the service request is available or until the timeout expires. More...

Additional Inherited Members
Public Attributes inherited from ignition::transport::IReqHandler
bool	repAvailable
	When there is a blocking service call request, the call can be unlocked when a service call REP is available. More...
Protected Attributes inherited from ignition::transport::IReqHandler
std::condition_variable_any	condition
	Condition variable used to wait until a service call REP is available. More...
std::string	hUuid
	Unique handler's UUID. More...
std::string	rep
	Stores the service response as raw bytes. More...
bool	result
	Stores the result of the service call. More...

Detailed Description

template<typename Req, typename Rep>
class ignition::transport::ReqHandler< Req, Rep >

It creates a reply handler for the specific protobuf messages used.

'Req' is a protobuf message type containing the input parameters of the service request. 'Rep' is a protobuf message type that will be filled with the service response.

Constructor & Destructor Documentation

ReqHandler()

template<typename Req , typename Rep >

ignition::transport::ReqHandler< Req, Rep >::ReqHandler ( const std::string &  _nUuid )

inlineexplicit

Member Function Documentation

CreateMsg()

template<typename Req , typename Rep >

std::shared_ptr<Rep> ignition::transport::ReqHandler< Req, Rep >::CreateMsg ( const std::string &  _data ) const

inline

Create a specific protobuf message given its serialized data.

Parameters

[in]

_data

The serialized data.

Returns

Pointer to the specific protobuf message.

NotifyResult()

template<typename Req , typename Rep >

void ignition::transport::ReqHandler< Req, Rep >::NotifyResult ( const std::string &  _rep, const bool  _result  )

inlinevirtual

Executes the callback registered for this handler and notify a potential requester waiting on a blocking call.

Parameters

[in]	_rep	Serialized data containing the response coming from the service call responser.
[in]	_result	Contains the result of the service call coming from the service call responser.

Implements ignition::transport::IReqHandler.

RepTypeName()

template<typename Req , typename Rep >

virtual std::string ignition::transport::ReqHandler< Req, Rep >::RepTypeName ( ) const

inlinevirtual

Get the message type name used in the service response.

Returns

Message type name.

Implements ignition::transport::IReqHandler.

ReqTypeName()

template<typename Req , typename Rep >

virtual std::string ignition::transport::ReqHandler< Req, Rep >::ReqTypeName ( ) const

inlinevirtual

Get the message type name used in the service request.

Returns

Message type name.

Implements ignition::transport::IReqHandler.

Serialize()

template<typename Req , typename Rep >

bool ignition::transport::ReqHandler< Req, Rep >::Serialize ( std::string &  _buffer ) const

inlinevirtual

Serialize the Req protobuf message stored.

Parameters

[out]

_buffer

The serialized data.

Returns

True if the serialization succeed or false otherwise.

Implements ignition::transport::IReqHandler.

SetCallback()

template<typename Req , typename Rep >

void ignition::transport::ReqHandler< Req, Rep >::SetCallback ( const std::function< void(const Rep &_rep, const bool _result)> &  _cb )

inline

Set the callback for this handler.

Parameters

[in]	_cb	The callback with the following parameters:
[in]	_rep	Protobuf message containing the service response.
[in]	_result	True when the service request was successful or false otherwise.

SetMessage()

template<typename Req , typename Rep >

void ignition::transport::ReqHandler< Req, Rep >::SetMessage ( const Req *  _reqMsg )

inline

Set the REQ protobuf message for this handler.

Parameters

[in]

_reqMsg

Protofub message containing the input parameters of of the service request.

SetResponse()

template<typename Req , typename Rep >

void ignition::transport::ReqHandler< Req, Rep >::SetResponse ( const Rep *  )

inline

This function is only used for compatibility with SetResponse() when [REP = google::protobuf::Message].

It shouldn't do anything.

Parameters

[in]

_repMsg

Protofub message containing the variable where the result will be stored.

---

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

• ReqHandler.hh