CPG_LEAVE(3)

💖 CPG_LEAVE(3) 💖

okay bestie, welcome to the Corosync Cluster Engine Programmer's Manual ✨ this one's a lil three-parter from the CPG library and it's literally the "goodbye, i'm out" button 🚪💨

🌸 NAME 🌸

cpg_leave — Leave a group in the CPG library 🫶

✨ SYNOPSIS ✨

#include <corosync/cpg.h>

int cpg_leave(cpg_handle_t handle, struct cpg_name *group);

🦋 DESCRIPTION 🦋

so, the cpg_leave function is what you call when you wanna leave a group. that's the whole vibe. once a group has been left, the process will no longer receive messages or notifications about events in that group. bye bye group chat 🫡

⚠️ but hold on — pay attention bestie, this is the part that gets people. a process is only deemed to have left the group once it has been notified (by its confchg callback) that it has left. so expect to receive at least one confchg callback after calling this function. that's not a bug, that's just the handshake 💅 don't be out here thinking you're gone before the callback says you're gone.

the argument group is what you use to specify the group to leave. it is currently ignored though, because only one group can be joined per handle. it's literally just sitting there in the signature to allow for future development 👑 (iconic of them, honestly)

🎀 RETURN VALUE 🎀

this call returns the CS_OK value if it worked, otherwise an error gets returned. no in-between, no grey area 💀

💜 ERRORS 💜

ngl bestie... the errors are undocumented 🙈 that's it, that's the section.

🌈 SEE ALSO 🌈

• cpg_overview(3), cpg_initialize(3), cpg_finalize(3), cpg_fd_get(3)
• cpg_dispatch(3), cpg_join(3), cpg_leave(3), cpg_mcast_joined(3)
• cpg_membership_get(3) cpg_zcb_alloc(3) cpg_zcb_free(3)
• cpg_zcb_mcast_joined(3) cpg_context_get(3) cpg_context_set(3)
• cpg_local_get(3)

and the error codes, gathered here like a lil friend group ✨

• 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

okay that's the whole page bestie, go forth and leave your groups responsibly 💅✨

mwah 💖 this was the corosync Man Page, dated 2004-08-31, and you've been reading CPG_LEAVE(3) — periodt. 👑🌸