rtapi_exit(3rtapi)

πŸ“¦
version 2.9.4 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ rtapi_exit ✨

okay so bestie, welcome to the RTAPI manual β€” this one's rtapi_exit(3rtapi), and it's literally the "bye bye" button for RTAPI. short page, but important, so stay with me 🫢

🌸 NAME 🌸

rtapi_exit β€” Shut down RTAPI


πŸŽ€ SYNTAX πŸŽ€

int rtapi_exit(int module_id)

πŸ’… ARGUMENTS πŸ’…

  • module_id β€” the rtapi module identifier that an earlier call to rtapi_init handed you back. yes, the same one. don't make one up, she'll know πŸ™ˆ

πŸ¦‹ DESCRIPTION πŸ¦‹

rtapi_exit shuts down and cleans up the RTAPI. that's the whole vibe: teardown, tidy up, leave the place spotless ✨

and it is not optional β€” it must be called prior to exit by any module that called rtapi_init. like, if you opened it, you close it. no ghost modules haunting the place πŸ‘‘


🌈 REALTIME CONSIDERATIONS 🌈

call this only from within non-realtime or realtime init/cleanup code. do NOT call it from realtime tasks. like, not the move, bestie πŸ’€


⭐ RETURN VALUE ⭐

returns a RTAPI status code. that's it, that's the tea πŸ“


real talk: if you called rtapi_init, you owe RTAPI an rtapi_exit. periodt πŸ’–

mwah, that's the page πŸ’œ this lil gem comes from the LinuxCNC Documentation, dated 2006-10-12 β€” vintage but still iconic, no cap. take care of your modules and they'll take care of you 🧚✨