Public Member Functions | Protected Attributes | List of all members
ignition::transport::ISubscriptionHandler Class Referenceabstract

ignition/transport/SubscriptionHandler.hh More...

#include <SubscriptionHandler.hh>

Inheritance diagram for ignition::transport::ISubscriptionHandler:
Inheritance graph
[legend]

Public Member Functions

 ISubscriptionHandler (const std::string &_nUuid)
 Constructor. More...
 
virtual ~ISubscriptionHandler ()
 Destructor. More...
 
virtual const std::shared_ptr< transport::ProtoMsgCreateMsg (const std::string &_data) const =0
 Create a specific protobuf message given its serialized data. More...
 
std::string HandlerUuid () const
 Get the unique UUID of this handler. More...
 
std::string NodeUuid () const
 Get the node UUID. More...
 
virtual bool RunLocalCallback (const transport::ProtoMsg &_msg) const =0
 Executes the local callback registered for this handler. More...
 
virtual std::string TypeName ()=0
 Get the type of the messages from which this subscriber handler is subscribed. More...
 

Protected Attributes

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

Detailed Description

ignition/transport/SubscriptionHandler.hh

Interface class used to manage generic protobub messages.

Constructor & Destructor Documentation

◆ ISubscriptionHandler()

ignition::transport::ISubscriptionHandler::ISubscriptionHandler ( const std::string &  _nUuid)
inline

Constructor.

Parameters
[in]_nUuidUUID of the node registering the handler.

◆ ~ISubscriptionHandler()

virtual ignition::transport::ISubscriptionHandler::~ISubscriptionHandler ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ CreateMsg()

virtual const std::shared_ptr<transport::ProtoMsg> ignition::transport::ISubscriptionHandler::CreateMsg ( const std::string &  _data) const
pure virtual

Create a specific protobuf message given its serialized data.

Parameters
[in]_dataThe serialized data.
Returns
Pointer to the specific protobuf message.

Implemented in ignition::transport::SubscriptionHandler< T >.

◆ HandlerUuid()

std::string ignition::transport::ISubscriptionHandler::HandlerUuid ( ) const
inline

Get the unique UUID of this handler.

Returns
A string representation of the handler UUID.

◆ NodeUuid()

std::string ignition::transport::ISubscriptionHandler::NodeUuid ( ) const
inline

Get the node UUID.

Returns
The string representation of the node UUID.

◆ RunLocalCallback()

virtual bool ignition::transport::ISubscriptionHandler::RunLocalCallback ( const transport::ProtoMsg _msg) const
pure virtual

Executes the local callback registered for this handler.

Parameters
[in]_msgProtobuf message received.
Returns
True when success, false otherwise.

Implemented in ignition::transport::SubscriptionHandler< T >.

◆ TypeName()

virtual std::string ignition::transport::ISubscriptionHandler::TypeName ( )
pure virtual

Get the type of the messages from which this subscriber handler is subscribed.

Returns
String representation of the message type.

Implemented in ignition::transport::SubscriptionHandler< T >.

Member Data Documentation

◆ hUuid

std::string ignition::transport::ISubscriptionHandler::hUuid
protected

Unique handler's UUID.


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