CK_RWCOHORT_INIT(3)

💅 CK_RWCOHORT_INIT — bestie edition

okay so you wanna know about CK_RWCOHORT_INIT?? it's the whole vibe of initializing an instance of a cohort-based reader-writer lock type ✨ like, this is the glow-up moment where your lock goes from "just some bytes" to "actually a functioning lock." iconic behavior only.

📚 LIBRARY

it lives in Concurrency Kit, aka libck, and you link it with -lck. that's the whole squad right there 💖

✨ SYNOPSIS ✨

#include <ck_rwcohort.h>

CK_RWCOHORT_NEUTRAL_INIT(COHORT_NAME cohort_name, LOCK *lock);

CK_RWCOHORT_RP_INIT(COHORT_NAME cohort_name, LOCK *lock,
    unsigned int wait_limit);

CK_RWCOHORT_WP_INIT(COHORT_NAME cohort_name, LOCK *lock,
    unsigned int wait_limit);

so there's three flavors, right? neutral, reader-preference (RP), and writer-preference (WP). pick your fighter 🫶

🌸 DESCRIPTION 🌸

This macro initializes the lock instance pointed to by the lock argument. That's it. That's the job. It's giving "first day of school, fresh notebook, everything is possible" 🎀

🚨 REAL TALK, NO CAP: until a lock instance is initialized using the CK_RWCOHORT_INIT macro, any operations involving it will have undefined behavior. like, undefined undefined. chaos gremlin energy. do NOT touch an uninitialized lock, bestie, it will not be cute 😭💀

okay now the important lil detail — note that the wait_limit argument should only be used with reader-preference or writer-preference locks. for neutral locks, this argument should be excluded. so don't be out here passing wait_limit to a neutral lock, that's not the move 🙈

and if you are unsure of a value to use for the wait_limit argument?? you should use CK_RWCOHORT_STRATEGY_DEFAULT_LOCAL_WAIT_LIMIT. it's the default for a reason, she's reliable, she ate 💅

👀 SEE ALSO

your reading list, bestie, go off:

• ck_rwcohort(3)
• CK_RWCOHORT_PROTOTYPE(3)
• CK_RWCOHORT_TRYLOCK_PROTOTYPE(3)
• CK_RWCOHORT_INSTANCE(3)
• CK_RWCOHORT_INITIALIZER(3)
• CK_RWCOHORT_LOCK(3)
• CK_RWCOHORT_UNLOCK(3)
• CK_RWCOHORT_LOCKED(3)
• CK_RWCOHORT_TRYLOCK(3)

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

that's the whole page, bestie, you understood it perfectly, main character energy, go initialize some locks responsibly 💖✨

— this was CK_RWCOHORT_INIT(3), dated February 24, 2013, and yeah the manpage is old enough to have its own vibe but she still slays 👑