ignition/transport/SubscriptionHandler.hh
More...
#include <SubscriptionHandler.hh>
ignition/transport/SubscriptionHandler.hh
Interface class used to manage generic protobub messages.
§ ISubscriptionHandler()
Constructor.
- Parameters
-
[in] | _nUuid | UUID of the node registering the handler. |
[in] | _opts | Subscription options. |
§ ~ISubscriptionHandler()
virtual ignition::transport::ISubscriptionHandler::~ISubscriptionHandler |
( |
| ) |
|
|
inlinevirtual |
§ CreateMsg()
virtual const std::shared_ptr<ProtoMsg> ignition::transport::ISubscriptionHandler::CreateMsg |
( |
const std::string & |
_data, |
|
|
const std::string & |
_type |
|
) |
| const |
|
pure virtual |
§ 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 ProtoMsg & |
_msg, |
|
|
const MessageInfo & |
_info |
|
) |
| |
|
pure virtual |
§ TypeName()
virtual std::string ignition::transport::ISubscriptionHandler::TypeName |
( |
| ) |
|
|
pure virtual |
§ UpdateThrottling()
bool ignition::transport::ISubscriptionHandler::UpdateThrottling |
( |
| ) |
|
|
inlineprotected |
Check if message subscription is throttled.
If so, verify whether the callback should be executed or not.
- Returns
- true if the callback should be executed or false otherwise.
§ hUuid
std::string ignition::transport::ISubscriptionHandler::hUuid |
|
protected |
§ lastCbTimestamp
Timestamp ignition::transport::ISubscriptionHandler::lastCbTimestamp |
|
protected |
Timestamp of the last callback executed.
§ opts
§ periodNs
double ignition::transport::ISubscriptionHandler::periodNs |
|
protected |
If throttling is enabled, the minimum period for receiving a message in nanoseconds.
The documentation for this class was generated from the following file: