CK_RHS_STAT(3)

💖 ck_rhs_stat — bestie, let's get that hash set status 💖

okay so this page lives in the CK_RHS_STAT(3) manual, and it's brought to you by the Concurrency Kit — that's libck, you link it with -lck. 🎀

🌸 NAME 🌸

ck_rhs_stat — get hash set status. she's nosy, she wants the receipts, and honestly? valid. 💅

📚 LIBRARY 📚

Concurrency Kit (that's libck, and yes you pass -lck when you're building). 🧚

✨ SYNOPSIS ✨

#include <ck_rhs.h>

void
ck_rhs_stat(ck_rhs_t *hs, struct ck_rhs_stat *st);

🦋 DESCRIPTION 🦋

so ck_rhs_stat(3) is literally just a lil gossip session with your hash set. it takes all the juicy statistics and stores them in the object that st points at. no cap. 🫶

and the ck_rhs_stat structure is defined like this, exactly:

struct ck_rhs_stat {
        unsigned long n_entries;    /* Current number of keys in hash set. */
        unsigned int probe_maximum; /* Longest read-side probe sequence. */
};

so n_entries is how many keys are in the hash set right now — like, the current headcount. and probe_maximum is the longest read-side probe sequence, which is giving "how far did we have to dig to find someone" energy. iconic. 👑

🎀 RETURN VALUES 🎀

ck_rhs_stat(3) has no return value. void. nothing. she gives you stats and then she's gone, main character exit. 💀

💀 ERRORS 💀

okay bestie, listen up because this part is not a vibe:

• behavior is undefined if hs is uninitialized. do not do that. do not pass me an uninitialized hash set. 😭
• behavior is undefined if this function is called by a non-writer thread. like, writer threads only, periodt. don't be the friend who tries it from the wrong thread. 🙈

fr fr, "undefined behavior" is not cute. it's the "we literally cannot tell you what happens" tier. respect the writer-thread rule. 🌈

👑 SEE ALSO 👑

• ck_rhs_init(3)
• ck_rhs_move(3)
• ck_rhs_destroy(3)
• CK_RHS_HASH(3)
• ck_rhs_iterator_init(3)
• ck_rhs_next(3)
• ck_rhs_get(3)
• ck_rhs_put(3)
• ck_rhs_put_unique(3)
• ck_rhs_set(3)
• ck_rhs_fas(3)
• ck_rhs_remove(3)
• ck_rhs_grow(3)
• ck_rhs_gc(3)
• ck_rhs_rebuild(3)
• ck_rhs_count(3)
• ck_rhs_reset(3)
• ck_rhs_reset_size(3)

and if you want even more, the additional information is available at http://concurrencykit.org/ 🌐 — go read, it's giving ✨ research era ✨.

that's the whole page, babe. this one's dated September 17, 2012 and it's the CK_RHS_STAT(3) manual — mwah, sending you off with stats and good vibes only. 💜🌸✨