rtapi_app_exit(3rtapi)

rtapi_app_exit3rtapi

User-provided function to shut down a component

Usage

#include <rtapi_app.h>
void rtapi_app_exit(void) {...}

Arguments

None

Overview

The body of rtapi_app_exit, which is provided by the component author, generally consists of a call to rtapi_exit or hal_exit, preceded by other component-specific shutdown code.

This code is called when unloading a component which successfully initialized (i.e., returned zero from its rtapi_app_main). It is not called when the component did not successfully initialize.

Return code

None.

Realtime considerations

Called automatically by the rtapi infrastructure in an initialization (not realtime) context.

Releases

Unchanged in 2 releases since Debian 12 (Bookworm).

  1. 12–13

From linuxcnc-uspace-dev 1:2.9.4-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.