roar_vs_noop(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_vs_noop(3) — the RoarAudio Programmer's Manual, bestie edition 💖

okay so you're reading the RoarAudio Programmer's Manual and this lil page is all about roar_vs_noop(3) — the manual name is literally roar_vs_noop and it lives in section 3 of the manual, iykyk 🎀

✨ NAME ✨

roar_vs_noop — Send NOOP command to server 🫶

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

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

🦋 DESCRIPTION 🦋

This function sends a NOOP command to the server. it's giving "just checking you're still there" energy fr fr 💅

This is useful to ping the server or to be used as a keep-alive. so like, when you wanna make sure the connection isn't ghosting you, this is the move 👑

heads up bestie: this function may be implemented as a macro. no cap, don't be weird about it.

🎀 PARAMETERS 🎀

  • vss — the VS object to be used as server connection. this is your lil link to the server, your main character connector ✨
  • error — this is a pointer to an integer used to store the error value in case of error. this can be NULL if not used, but it is very recommended to use this error value to report good error messages to the user. like, please use it, your users deserve to know what went wrong 😭

💜 RETURN VALUE 💜

On success these calls return 0. on error, -1 is returned. that's it, that's the whole vibe check 🌈

🍓 EXAMPLES 🍓

FIXME

not me leaving the examples as FIXME 🙈 the original says exactly that and I'm not about to invent lore, periodt.

⭐ SEE ALSO ⭐

mwah 💋 that's the whole page. go ping something, bestie.

RoarAudio — May 2011 🌸 stay iconic, drink water, and remember: roar_vs_noop said 0 on success and -1 on error and that is the tea 💖✨🎀

📦 where this page comes from