Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
uavcan::RestartRequestServer Class Reference

#include <restart_request_server.hpp>

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

Public Member Functions

IRestartRequestHandlergetHandler () const
 
 RestartRequestServer (INode &node)
 
void setHandler (IRestartRequestHandler *handler)
 
int start ()
 

Private Types

typedef MethodBinder< const RestartRequestServer *, void(RestartRequestServer::*)(const ReceivedDataStructure< protocol::RestartNode::Request > &, protocol::RestartNode::Response &) const > RestartNodeCallback
 

Private Member Functions

void handleRestartNode (const ReceivedDataStructure< protocol::RestartNode::Request > &request, protocol::RestartNode::Response &response) const
 
- Private Member Functions inherited from uavcan::Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 

Private Attributes

IRestartRequestHandlerhandler_
 
ServiceServer< protocol::RestartNode, RestartNodeCallbacksrv_
 

Detailed Description

Convenience class for supporting the standard node restart service. Highly recommended to use.

Definition at line 38 of file restart_request_server.hpp.

Member Typedef Documentation

◆ RestartNodeCallback

typedef MethodBinder<const RestartRequestServer*, void (RestartRequestServer::*)(const ReceivedDataStructure<protocol::RestartNode::Request>&, protocol::RestartNode::Response&) const> uavcan::RestartRequestServer::RestartNodeCallback
private

Definition at line 42 of file restart_request_server.hpp.

Constructor & Destructor Documentation

◆ RestartRequestServer()

uavcan::RestartRequestServer::RestartRequestServer ( INode node)
inlineexplicit

Definition at line 68 of file restart_request_server.hpp.

Member Function Documentation

◆ getHandler()

IRestartRequestHandler* uavcan::RestartRequestServer::getHandler ( ) const
inline

Restart request handler configuration. All restart requests will be explicitly rejected if there's no handler installed.

Definition at line 77 of file restart_request_server.hpp.

◆ handleRestartNode()

void uavcan::RestartRequestServer::handleRestartNode ( const ReceivedDataStructure< protocol::RestartNode::Request > &  request,
protocol::RestartNode::Response &  response 
) const
inlineprivate

Definition at line 47 of file restart_request_server.hpp.

◆ setHandler()

void uavcan::RestartRequestServer::setHandler ( IRestartRequestHandler handler)
inline

Definition at line 78 of file restart_request_server.hpp.

◆ start()

int uavcan::RestartRequestServer::start ( )
inline

Starts the server. Returns negative error code.

Definition at line 84 of file restart_request_server.hpp.

Member Data Documentation

◆ handler_

IRestartRequestHandler* uavcan::RestartRequestServer::handler_
private

Definition at line 45 of file restart_request_server.hpp.

◆ srv_

ServiceServer<protocol::RestartNode, RestartNodeCallback> uavcan::RestartRequestServer::srv_
private

Definition at line 44 of file restart_request_server.hpp.


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


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