Public Member Functions | List of all members
uavcan::IRestartRequestHandler Class Referenceabstract

#include <restart_request_server.hpp>

Inheritance diagram for uavcan::IRestartRequestHandler:
Inheritance graph
[legend]

Public Member Functions

virtual bool handleRestartRequest (NodeID request_source)=0
 
virtual ~IRestartRequestHandler ()
 

Detailed Description

Implement this interface in the application to support the standard node restart service.

Definition at line 18 of file restart_request_server.hpp.

Constructor & Destructor Documentation

◆ ~IRestartRequestHandler()

virtual uavcan::IRestartRequestHandler::~IRestartRequestHandler ( )
inlinevirtual

Definition at line 21 of file restart_request_server.hpp.

Member Function Documentation

◆ handleRestartRequest()

virtual bool uavcan::IRestartRequestHandler::handleRestartRequest ( NodeID  request_source)
pure virtual

This method shall do either:

  • restart the local node immediately;
  • initiate the restart procedure to complete it asynchronously;
  • reject the restart request and return false.

If the restart requets was accepted, this method shall either return true or don't return at all.

Implemented in RestartHandler.


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


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:04