ARES_THREADSAFETY(3)

💖 ARES_THREADSAFETY 💖

okay bestie, welcome to ares_threadsafety(3), aka the little function that tells you whether your c-ares build is ✨thread-safe✨ or not. it lives in the Library Functions Manual, and it's literally one question with two answers. iconic behaviour, honestly.

🌸 NAME 🌸

ares_threadsafety — ask c-ares if it was built with thread-safety, yes or no, no cap.

✨ SYNOPSIS ✨

#include <ares.h>

ares_bool_t ares_threadsafety(void);

🦋 DESCRIPTION 🦋

so the way that ares_threadsafety(3) works is: it returns whether the library was built with thread safety enabled or not. that's it. that's the whole vibe check. 💅

as of c-ares 1.23.0, this simply means that every public function which references an ares_channel_t object will lock the channel on entry and release the lock on exit of the function. so like, nobody's fighting over the channel while someone else is using it. this will prevent concurrent thread access to the channel, thus ensuring no corruption can occur. no corruption bestie, we love that for us. 🫶

as of c-ares 1.26.0, this also indicates if ARES_OPT_EVENT_THREAD can be passed to ares_init_options(3). so it's lowkey doing double duty now. main character energy fr fr. 👑

🎀 RETURN VALUES 🎀

ares_threadsafety(3) can return any of the following values:

• ARES_TRUE — Built with thread safety. slay, you're safe 💖
• ARES_FALSE — Built without thread safety. not me finding out the hard way 😭

🌈 AVAILABILITY 🌈

this function was first introduced in c-ares version 1.23.0. so if you're on something older, sorry babe, she's not there yet. 🙈

⭐ SEE ALSO ⭐

• ares_init(3)
• ares_init_options(3)
• ares_destroy(3)
• ares_dup(3)
• ares_library_init(3)
• ares_set_servers(3)

okay that's the whole page, you ate that. 💅✨

signing off with love from the c-ares squad — this one's dated 26 November 2023, and yeah, it's the ARES_THREADSAFETY(3) page, periodt. 🦋🎀💜