CK_ARRAY_PUT(3)

💅 CK_ARRAY_PUT(3) 💅

okay bestie, welcome to the ck_array_put page — yes it's from the Concurrency Kit (that's libck, link it with -lck) and it's literally one of the most-used little functions in the whole array saga. sit down, grab a strawberry 🍓, let's get into it.

🌸 NAME 🌸

ck_array_put — attempt immediate or deferred insertion of a pointer into array

like... you're sliding a pointer into an array and the array gets to decide when it actually lands there. iconic behavior tbh. ✨

📚 LIBRARY 📚

Concurrency Kit (that's libck, so you link with -lck) 🫶

🎀 SYNOPSIS 🎀

#include <ck_array.h>

bool
ck_array_put(ck_array_t *array, void *pointer);

two arguments, one bool, no drama. we love a minimal signature. 👑

✨ DESCRIPTION ✨

So the way that ck_array_put(3) works is: it attempts to insert the value of pointer into the array that array points to. that's the whole vibe.

But heads up — this function may incur additional memory allocations if there isn't already enough memory allocated in the array to hold a new entry. so like, it might go shopping for more memory mid-operation. no cap, that's just how it is. 🙈

Also, plot twist: the operation is free to apply the operation immediately if there's an opportunity for elimination with a pending (uncommitted) remove operation. so if a remove is just sitting there uncommitted and it could cancel out with your put — yeah, it might just go ahead and do that right then and there. it's giving ✨opportunistic✨. the array is the main character here, not you. 💅

💖 RETURN VALUES 💖

• true — slay, the put operation succeeded. 🎉
• false — otherwise, and the reason is internal allocation failures. 😭

that's it, that's the return value situation.

👀 SEE ALSO 👀

go read these next, they're all part of the same friend group:

• ck_array_init(3)
• ck_array_commit(3)
• ck_array_put_unique(3)
• ck_array_remove(3)
• ck_array_deinit(3)
• ck_array_length(3)
• ck_array_buffer(3)
• ck_array_initialized(3)
• CK_ARRAY_FOREACH(3)

and if you want even more info, additional information is available at http://concurrencykit.org/ 🌈

okay that's the whole page, you ate that. this one's dated October 18, 2013 and it lives under the name CK_ARRAY_PUT(3) — go forth and insert responsibly, bestie. mwah. 💋🦋