SAM_DATA_STORE(3)

💾 SAM_DATA_STORE(3) 💾

okay bestie, welcome to the Corosync Cluster Engine Programmer's Manual ✨ this is the page for sam_data_store(3), and we're gonna make it make sense, fr fr 🫶

🌸 NAME 🌸

sam_data_store — store user data 💅 (yes that's it, that's the whole name section, she's concise)

✨ SYNOPSIS ✨

#include <corosync/sam.h>

cs_error_t sam_data_store (const void *data, size_t size);

🎀 DESCRIPTION 🎀

so the sam_data_store function is the one you call when you wanna store data, and the whole point is that this data survives between instances 👑 like it outlives the current you, iconic behavior honestly.

the data parameter is a pointer to the memory holding the data you wanna store. and here's the cute part: the data gets stored in newly allocated memory inside the library, so the caller can safely delete their own copy right after the function call returns 🧚 no strings attached, no lingering references, we love a clean break.

you can also pass NULL as the parameter to remove and free whatever data was saved before. and in that case? the size argument is just ignored bestie, she said "not today" 🙈

the size parameter is the length of the data. that's it, that's the whole job.

wanna know how big your stored data is? use sam_data_getsize(3) 💖 wanna get it back? use sam_data_restore(3) 🦋

🌈 RETURN VALUE 🌈

this call returns CS_OK if everything slayed, otherwise an error comes back at you. no cap 😭

💀 ERRORS 💀

• CS_ERR_BAD_HANDLE — the component was never initialized by calling sam_initialize(3), or it already got finalized. like, you showed up to the party with no invite, or you showed up after everyone left 💀
• CS_ERR_NO_MEMORY — internal malloc/realloc failed because the data is too large. she simply could not hold all that 😭
• CS_ERR_LIBRARY — some internal error showed up, mostly because communication with the parent process failed. it's giving "it's not you, it's the parent process" 🙈

👀 SEE ALSO 👀

• sam_data_getsize(3)
• sam_data_restore(3)

and also, since we're being thorough (we always are 💅), here are the general error codes that can pop up 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

and that's the whole page, bestie!! this little cutie came from the corosync Man Page, dated 04/15/2010 🌸 go forth and store your data, you absolute main character 👑✨💖