ignition::transport::IRepHandler Class Reference

Interface class used to manage a replier handler. More...

#include <ignition/transport/RepHandler.hh>

Inheritance diagram for ignition::transport::IRepHandler:

Public Member Functions
	IRepHandler ()
	Constructor. More...
virtual	~IRepHandler ()=default
	Destructor. More...
std::string	HandlerUuid () const
	Get the unique UUID of this handler. More...
virtual std::string	RepTypeName () const =0
	Get the message type name used in the service response. More...
virtual std::string	ReqTypeName () const =0
	Get the message type name used in the service request. More...
virtual void	RunCallback (const std::string &_req, std::string &_rep, bool &_result)=0
	Executes the callback registered for this handler. More...
virtual void	RunLocalCallback (const transport::ProtoMsg &_msgReq, transport::ProtoMsg &_msgRep, bool &_result)=0
	Executes the local callback registered for this handler. More...

Protected Attributes
std::string	hUuid
	Unique handler's UUID. More...

Detailed Description

Interface class used to manage a replier handler.

Constructor & Destructor Documentation

ignition::transport::IRepHandler::IRepHandler ( )

inline

Constructor.

virtual ignition::transport::IRepHandler::~IRepHandler ( )

virtualdefault

Destructor.

Member Function Documentation

std::string ignition::transport::IRepHandler::HandlerUuid ( ) const

inline

Get the unique UUID of this handler.

Returns

a string representation of the handler UUID.

virtual std::string ignition::transport::IRepHandler::RepTypeName ( ) const

pure virtual

Get the message type name used in the service response.

Returns

Message type name.

Implemented in ignition::transport::RepHandler< Req, Rep >.

virtual std::string ignition::transport::IRepHandler::ReqTypeName ( ) const

pure virtual

Get the message type name used in the service request.

Returns

Message type name.

Implemented in ignition::transport::RepHandler< Req, Rep >.

virtual void ignition::transport::IRepHandler::RunCallback ( const std::string &  _req, std::string &  _rep, bool &  _result  )

pure virtual

Executes the callback registered for this handler.

Parameters

[in]	_req	Serialized data received. The data will be used to compose a specific protobuf message and will be passed to the callback function.
[out]	_rep	Out parameter with the data serialized.
[out]	_result	Service call result.

Implemented in ignition::transport::RepHandler< Req, Rep >.

virtual void ignition::transport::IRepHandler::RunLocalCallback ( const transport::ProtoMsg &  _msgReq, transport::ProtoMsg &  _msgRep, bool &  _result  )

pure virtual

Executes the local callback registered for this handler.

Parameters

[in]	_msgReq	Input parameter (Protobuf message).
[out]	_msgRep	Output parameter (Protobuf message).
[out]	_result	Service call result.

Implemented in ignition::transport::RepHandler< Req, Rep >.

Member Data Documentation

std::string ignition::transport::IRepHandler::hUuid

protected

Unique handler's UUID.

---

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

• RepHandler.hh