Ignition Transport

API Reference

8.1.0
IRepHandler Class Referenceabstract

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

#include <ignition/transport/RepHandler.hh>

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 bool RunCallback (const std::string &_req, std::string &_rep)=0
 Executes the callback registered for this handler. More...
 
virtual bool RunLocalCallback (const transport::ProtoMsg &_msgReq, transport::ProtoMsg &_msgRep)=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

◆ IRepHandler()

◆ ~IRepHandler()

virtual ~IRepHandler ( )
virtualdefault

Destructor.

Referenced by IRepHandler::IRepHandler().

Member Function Documentation

◆ HandlerUuid()

std::string HandlerUuid ( ) const
inline

Get the unique UUID of this handler.

Returns
a string representation of the handler UUID.

References IRepHandler::hUuid, IRepHandler::RepTypeName(), and IRepHandler::ReqTypeName().

◆ 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 >.

Referenced by IRepHandler::HandlerUuid().

◆ 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 >.

Referenced by IRepHandler::HandlerUuid().

◆ RunCallback()

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

Executes the callback registered for this handler.

Parameters
[in]_reqSerialized data received. The data will be used to compose a specific protobuf message and will be passed to the callback function.
[out]_repOut parameter with the data serialized.
[out]_resultService call result.

Implemented in RepHandler< Req, Rep >.

Referenced by IRepHandler::IRepHandler().

◆ RunLocalCallback()

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

Executes the local callback registered for this handler.

Parameters
[in]_msgReqInput parameter (Protobuf message).
[out]_msgRepOutput parameter (Protobuf message).
[out]_resultService call result.

Implemented in RepHandler< Req, Rep >.

Referenced by IRepHandler::IRepHandler().

Member Data Documentation

◆ hUuid

std::string hUuid
protected

Unique handler's UUID.

Referenced by IRepHandler::HandlerUuid().


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