SAM_HC_SEND(3)

💖 SAM_HC_SEND(3) 💖

okay bestie, welcome to the Corosync Cluster Engine Programmer's Manual ✨ this is the sam_hc_send page and it's lowkey one of the most important little calls you'll ever make, no cap.

🌸 NAME 🌸

sam_hc_send — send health check confirmation 🫶

🎀 SYNOPSIS 🎀

#include <corosync/sam.h>

cs_error_t sam_hc_send (void);

✨ DESCRIPTION ✨

so the sam_hc_send function is literally your app raising its hand and going "i'm alive!! i'm here!!" 💅 it's how you send a healthcheck confirmation from the application.

the way that you should call this regularly when you're configured for application driven healthchecking. like, on a schedule. do not ghost it. because if you don't call it, recovery action will be taken 😭 (yes, the dramatic kind).

but — and this is the important part, bestie — when you're using event driven healthchecking, this function should not be used. different vibe entirely, okay? don't mix them up 🙈

💫 RETURN VALUE 💫

this call returns the CS_OK value if it's successful 🎉 otherwise an error is returned. simple as that.

💀 ERRORS 💀

• CS_ERR_BAD_HANDLE — health checking is not in running state (meaning sam_start(3) has not been executed) or the function is called after stop/finalization of SAM. it's giving "you showed up to the party after it ended" energy.

👑 SEE ALSO 👑

• sam_start(3)
• sam_stop(3)
• sam_hc_callback_register(3)

and here's the rest of the error crew, because they live down here too 🫶:

• 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

ngl, that CS_ERR_BAD_HANDLE one gets everybody at least once. call sam_start(3) first, bestie, i'm begging 🙏

okay that's the whole page!! this was the corosync Man Page, dated 12/01/2009, and you just read SAM_HC_SEND(3) 💖 slay, go keep your app alive, you got this 🦋✨