libuav original

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

INodeInfoListener Class Reference

INodeInfoListener Class Reference

Classes that need to receive GetNodeInfo responses should implement this interface. More...

#include <node_info_retriever.hpp>

Inherited by NodeInfoListener, and FirmwareUpdateTrigger.

Public Member Functions

virtual void handleNodeInfoRetrieved (NodeID node_id, const protocol::GetNodeInfo::Response &node_info)=0
 Called when a response to GetNodeInfo request is received.
virtual void handleNodeInfoUnavailable (NodeID node_id)=0
 Called when the retriever decides that the node does not support the GetNodeInfo service.
virtual void handleNodeStatusChange (const NodeStatusMonitor::NodeStatusChangeEvent &event)
 This call is routed directly from NodeStatusMonitor.
virtual void handleNodeStatusMessage (const ReceivedDataStructure< protocol::NodeStatus > &msg)
 This call is routed directly from NodeStatusMonitor.

Detailed Description

Classes that need to receive GetNodeInfo responses should implement this interface.

Definition at line 21 of file node_info_retriever.hpp.


Member Function Documentation

virtual void handleNodeInfoRetrieved ( NodeID  node_id,
const protocol::GetNodeInfo::Response &  node_info 
) [pure virtual]

Called when a response to GetNodeInfo request is received.

This happens shortly after the node restarts or becomes online for the first time.

Parameters:
node_idNode ID of the node
responseNode info struct
virtual void handleNodeInfoUnavailable ( NodeID  node_id ) [pure virtual]

Called when the retriever decides that the node does not support the GetNodeInfo service.

This method will never be called if the number of attempts is unlimited.

virtual void handleNodeStatusChange ( const NodeStatusMonitor::NodeStatusChangeEvent &  event ) [virtual]

This call is routed directly from NodeStatusMonitor.

Default implementation does nothing.

Parameters:
eventNode status change event

Definition at line 43 of file node_info_retriever.hpp.

virtual void handleNodeStatusMessage ( const ReceivedDataStructure< protocol::NodeStatus > &  msg ) [virtual]

This call is routed directly from NodeStatusMonitor.

Default implementation does nothing.

Parameters:
msgNode status message

Definition at line 53 of file node_info_retriever.hpp.