CPG_ZCB_FREE(3)

💖 CPG_ZCB_FREE — bestie edition 💖

okay so this is a page from the Corosync Cluster Engine Programmer's Manual, and it's about cpg_zcb_free — the little cleanup icon that frees a zero copy buffer. short page, big vibes, let's go ✨

✨ NAME ✨

cpg_zcb_free — frees a zero copy buffer 🧚

🌸 SYNOPSIS 🌸

#include <corosync/cpg.h>

int cpg_zcb_fre(cpg_handle_t handle, void *buffer);

yes bestie, it really says cpg_zcb_fre up there — that's exactly how it's written, so I'm keeping it character for character. no cap, don't @ me 💀

🎀 DESCRIPTION 🎀

so the cpg_zcb_free function does one thing and it does it gorgeously: it frees a zero copy buffer. that's it. that's the whole job. main character energy fr fr 🫶

the argument handle describes the handle on which the buffer will be allocated. 👑

the argument buffer is the zero copy buffer to free. bye bestie, releasing you back into the wild 🦋

💅 RETURN VALUE 💅

this call returns the CS_OK value if it's successful. and if it's not? an error gets returned instead. simple as that, no notes ✨

😭 ERRORS 😭

the errors are undocumented. that's it. that's the whole error section. we know nothing and we're at peace with it 🙈

🔥 SEE ALSO 🔥

go read these next, they're all icons:

• 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 here's the error code rundown, all of them, no skips:

• 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

💜 reminder: the errors themselves are undocumented, so treat these as the list of things you might see, not a promise about when you'll see them.

and that's the whole page bestie, we ate and left no crumbs 💅✨ this one's from the corosync Man Page, dated 2009-04-15, filed under CPG_ZCB_FREE(3) — vintage, iconic, obsessed, periodt 🎀🌈💖