Q_PUSH(3)

📦 version 0.11.2, in debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 Q_PUSH(3) — the Librecast Programmer's Manual, bestie edition 💖

okay so welcome to the Librecast Programmer's Manual, page Q_PUSH(3) 🌸 pull up a chair, we're pushing jobs onto queues and it's gonna be iconic.

✨ NAME ✨

q_push — push a job onto a smolq queue 🫶

📚 LIBRARY 📚

Librecast library (liblibrecast, -llibrecast) 💜

🌈 SYNOPSIS 🌈

#include <librecast/q.h>

int  q_push(q_t *q, void *(*f)(void *), void *restrict arg);
int  q_trypush(q_t *q, void *(*f)(void *), void *restrict arg);

Compile and link with -llibrecast. no cap, you gotta have that flag ✨

👑 DESCRIPTION 👑

So here's the tea, bestie 🍓:

  • q_push() pushes f onto the queue q with argument arg. That's it. That's the whole vibe. 💅
  • q_trypush() is literally the same as q_push() except that if the queue writer lock cannot be immediately obtained, then the call returns an error (errno set to EAGAIN) instead of blocking. she does NOT wait around, she's got places to be 😤
Like, q_push() will just stand there patiently until it can get in. q_trypush() is the "if you're not free in 0.2 seconds I'm leaving" friend 🙈

⭐ RETURN VALUE ⭐

  • The q_push() function returns zero on success 🎀
  • On error, -1 is returned and errno is set to indicate the error 💀

🦋 ERRORS 🦋

  • EAGAIN (q_trypush()) — The operation could not be performed without blocking. (i.e., the queue was full). she's FULL full, bestie 😭

The function can also fail with the errors for sem_post(3) or sem_wait(3). so go read those too, iykyk 🧚

🌸 SEE ALSO 🌸

q_job_seek(3), q_pool_create(3), q_pool_destroy(3), q_init(3), q_free(3), q_wait(3), sem_post(3), sem_wait(3) — the whole friend group, go say hi 💖

and that's the page!! this one's from the LIBRECAST era, dated 2023-07-25, filed under Q_PUSH(3) 👑 stay hydrated, read your semaphores, and go push some jobs bestie 🫶✨

📦 where this page comes from