nros C++ API
Lightweight ROS 2 client for embedded real-time systems (C++ headers)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
nros::PreShutdownCallbackHandle Class Reference

#include <executor.hpp>

Inheritance diagram for nros::PreShutdownCallbackHandle:
Inheritance graph
[legend]
Collaboration diagram for nros::PreShutdownCallbackHandle:
Collaboration graph
[legend]

Public Member Functions

 ShutdownCallbackHandle ()
 
 ShutdownCallbackHandle (nros_cpp_shutdown_callback_handle_t value)
 
- Public Member Functions inherited from nros::ShutdownCallbackHandle
 ShutdownCallbackHandle ()
 
 ShutdownCallbackHandle (nros_cpp_shutdown_callback_handle_t value)
 
bool valid () const
 True when this handle came from a successful registration.
 
nros_cpp_shutdown_callback_handle_t value () const
 The raw FFI value, for passing to the C entry points directly.
 

Detailed Description

Handle to a PRE-shutdown callback — rclcpp's rclcpp::PreShutdownCallbackHandle.

A distinct type from [OnShutdownCallbackHandle], as in rclcpp, so the compiler refuses remove_on_shutdown_callback(a_pre_handle). The runtime value carries its phase too, so the same mistake made through the C API fails instead of removing the wrong callback — but a compile error is a better place to learn it.

Member Function Documentation

◆ ShutdownCallbackHandle() [1/2]

nros::ShutdownCallbackHandle::ShutdownCallbackHandle ( )
inline

An empty handle. valid() is false; passing it to a remove does nothing and reports false.

◆ ShutdownCallbackHandle() [2/2]

nros::ShutdownCallbackHandle::ShutdownCallbackHandle ( nros_cpp_shutdown_callback_handle_t  value)
inlineexplicit

Wrap a raw handle from the C FFI. Rarely needed directly — the add_*_shutdown_callback methods hand back a typed handle.


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