IRepHandler Class Reference

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

#include <gz/transport/RepHandler.hh>

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

Protected Attributes
std::unique_ptr< IRepHandlerPrivate >	dataPtr
	Private data.

Detailed Description

Interface class used to manage a replier handler.

Constructor & Destructor Documentation

IRepHandler()

IRepHandler ( const std::string &  _pUuid, const std::string &  _nUuid  )

explicit

Constructor.

Parameters

[in]	_pUuid	Process UUID.
[in]	_nUuid	Node UUID.

~IRepHandler()

virtual ~IRepHandler ( )

virtual

Destructor.

Member Function Documentation

HandlerUuid()

std::string HandlerUuid

(

)

const

Get the unique UUID of this handler.

Returns

a string representation of the handler UUID.

RepTypeName()

virtual std::string RepTypeName ( ) const

pure virtual

Get the message type name used in the service response.

Returns

Message type name.

Implemented in RepHandler< Req, Rep >.

ReqTypeName()

virtual std::string ReqTypeName ( ) const

pure virtual

Get the message type name used in the service request.

Returns

Message type name.

Implemented in RepHandler< Req, Rep >.

RunCallback()

virtual bool RunCallback ( const std::string &  _req, std::string &  _rep  )

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.

Returns

Service call result.

Implemented in RepHandler< Req, Rep >.

RunLocalCallback()

virtual bool RunLocalCallback ( const transport::ProtoMsg &  _msgReq, transport::ProtoMsg &  _msgRep  )

pure virtual

Executes the local callback registered for this handler.

Parameters

[in]	_msgReq	Input parameter (Protobuf message).
[out]	_msgRep	Output parameter (Protobuf message).

Returns

Service call result.

Implemented in RepHandler< Req, Rep >.

Member Data Documentation

dataPtr

std::unique_ptr<IRepHandlerPrivate> dataPtr

protected

Private data.

---

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

• RepHandler.hh