SAM_STOP(3)

💖 SAM_STOP(3) — sam_mark_failed 💖

okay bestie, welcome to the Corosync Cluster Engine Programmer's Manual, section 3 🎀 this one's about sam_mark_failed, and ngl it's the "yeah no this process is DONE" button. let's get into it 🦋

✨ NAME ✨

sam_mark_failed — Mark process failed 💀

✨ SYNOPSIS ✨

#include <corosync/sam.h>

cs_error_t sam_mark_failed (void);

✨ DESCRIPTION ✨

so the sam_mark_failed function is used with SAM_RECOVERY_POLICY_CMAP — mostly alongside SAM_RECOVERY_POLICY_RESTART — to mark a process failed. periodt.

and like… a process that's been marked failed gets killed without sending the warn signal, and the control process will exit exactly the way it does with the SAM_RECOVERY_POLICY_QUIT policy. 😭

also the Condb key state gets set to failed so the corosync watchdog can take whatever action it needs to take. it's giving "we handled it, the watchdog handles the rest" energy 👑

✨ RETURN VALUE ✨

this call returns the CS_OK value if it worked, otherwise an error is returned. simple as that 🫶

✨ ERRORS ✨

here's the vibe-check-failed list, bestie:

• CS_ERR_BAD_HANDLE — the library was not initialized by calling sam_initialize(3), or it was already finalized 🙈
• CS_ERR_INVALID_PARAM — the recovery policy doesn't have the SAM_RECOVERY_POLICY_CMAP flag set 💅
• CS_ERR_LIBRARY — some internal error showed up (communication with the parent process) 😭

✨ SEE ALSO ✨

• sam_initialize(3)

and the lil bonus error-code glossary that comes along with it 🌈

• CS_ERR_TRY_AGAIN — Resource temporarily unavailable
• CS_ERR_INVALID_PARAM — Invalid argument
• CS_ERR_ACCESS — Permission denied
• CS_ERR_LIBRARY — The connection failed
• CS_ERR_INTERRUPT — System call interrupted by a signal
• CS_ERR_NOT_SUPPORTED — The requested protocol/functionality not supported
• CS_ERR_MESSAGE_ERROR — Incorrect auth message received
• CS_ERR_NO_MEMORY — Not enough memory to complete the requested task

lowkey important: once a process is marked failed it's killed with no warn signal — no goodbye, no warning shot, just gone. and the Condb key state flips to failed. know that going in, bestie 🎀

that's the whole page, you ate it up fr fr ⭐ this was the corosync Man Page, page SAM_STOP(3), dated 21/05/2010 — mwah, go slay some clusters 💖✨🧚