roar_vs_iterate(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_vs_iterate — the roar_vs_iterate(3) glow-up ✨

okay bestie, sit down, hydrate, and let me tell you about roar_vs_iterate and its ride-or-die roar_vs_run from the RoarAudio Programmer's Manual. it's giving stream iteration, and honestly? we're obsessed. 🦋

🌸 NAME 🌸

roar_vs_iterate, roar_vs_run — the two functions that iterate streams. that's it. that's the vibe. 💅

✨ SYNOPSIS ✨

#include <roaraudio.h>

int     roar_vs_iterate       (roar_vs_t * vss, int wait, int * error);

int     roar_vs_run           (roar_vs_t * vss, int * error);

like, look at those signatures. so clean. so iconic. no notes. 👑

🎀 DESCRIPTION 🎀

okay so here's the tea, bestie. 🍓

roar_vs_iterate() does the actual work: it sends a block of data from the local buffer to the server, or it reads data from the server into the local buffer — and when it's doing that, it's in blocking mode. OR, if you're in file mode, it pushes or pulls data to or from the server. either way, data is moving. main character behavior fr fr. 🔥

roar_vs_run() is the same thing as roar_vs_iterate() except it's the loops-forever version — it keeps going until EOF or an error shows up. no cap. it just keeps iterating. periodt. 💀

🧚 PARAMETERS 🧚

  • vss — the VS object you're using. your little guy. your blorbo. 🫶
  • wait — the patience setting, lowkey. if it's ROAR_VS_WAIT, then roar_vs_iterate() will block until data has been synced with the server. if it's ROAR_VS_NOWAIT, then roar_vs_iterate() will not block if no data can be send to or read from the server. choose wisely bestie, one of these makes you wait and one of these does not. 🙈
  • error — a pointer to an integer where the error value gets stored if something goes wrong. it can be NULL if you're not using it, but hiiiighkey it is very recommended to actually use this error value so you can report good error messages to the user. don't be the person who passes NULL and then has no idea why everything is on fire. 😭

⭐ RETURN VALUE ⭐

okay so, the receipts: 📜

  • On EOF these calls return 0.
  • roar_vs_iterate() returns a positive value on non-EOF success. slay.
  • On error, -1 is returned. 😭

🌈 EXAMPLES 🌈

FIXME

(the original literally just says FIXME bestie, I'm not gonna invent examples and lie to you, that would be so not it 💀)

💜 SEE ALSO 💜

go read those too, iykyk. 📚✨

mwah 💋 that's a wrap! this little page came to you from the fine folks at RoarAudio, dated June 2011 — yeah she's a vintage icon, an OG, and she still eats. 🎀👑✨

📦 where this page comes from