CK_EPOCH_POLL(3)

💅 CK_EPOCH_POLL — bestie edition ✨

okay so you're in the CK_EPOCH_POLL(3) section of the manual, which means we're talking about Concurrency Kit and the whole epoch reclamation vibe. sit down, grab a strawberry 🍓, we're doing this.

🌸 NAME 🌸

ck_epoch_poll — a non-blocking little poll of your epoch object, checking whether it's time to run dispatch cycles 👑

📚 LIBRARY 📚

Concurrency Kit — that's libck, and you link it with -lck. iconic. no cap. 🫶

✨ SYNOPSIS ✨

#include <ck_epoch.h>

bool
ck_epoch_poll(ck_epoch_record_t *record);

like, that's the whole thing. one function. one record pointer. slay.

💖 DESCRIPTION 💖

So ck_epoch_poll(3) will attempt to dispatch any functions associated with the object pointed to by epoch — those are the ones you queued up with ck_epoch_call(3) — but ONLY if it's deemed safe. safety first, always. 🧚

The way that this function exists is specifically for the case where the cost of epoch reclamation has to be amortized over time, in a manner that does not affect caller progress. so basically: you don't wanna pay the whole bill at once, you wanna spread it out, and you don't wanna block anyone while you do it. it's giving "responsible adult energy" but make it concurrency. 💀

🎀 RETURN VALUES 🎀

This function returns false if the following conditions are met:

• no memory was reclaimed 💀
• the records are not</> in a grace period
• no forward progress was made

(so like, false is the "we literally did nothing, bestie" answer. read it and weep 😭)

🚨 ERRORS 🚨

Behavior is undefined if the object pointed to by record has not been previously registered via ck_epoch_register(3).

fr fr do NOT skip the register step. that's not a vibe, that's a crash. 🙈

🔥 SEE ALSO 🔥

• ck_epoch_init(3)
• ck_epoch_register(3)
• ck_epoch_unregister(3)
• ck_epoch_recycle(3)
• ck_epoch_synchronize(3)
• ck_epoch_reclaim(3)
• ck_epoch_barrier(3)
• ck_epoch_call(3)
• ck_epoch_begin(3)
• ck_epoch_end(3)

Additional information available at http://concurrencykit.org/ 🌈

and that's the whole page, bestie — this was the Concurrency Kit manual, dated September 2, 2012. yes it's old, yes it still eats, we don't talk about it. periodt. 💅✨👑