roar_exit(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_exit(3) — the RoarAudio girlies' guide to telling the sound server to go night-night 💖

okay so bestie, welcome to the System Manager's Manual: RoarAudio section, page roar_exit(3). this is a lil two-for-one deal: roar_exit and roar_terminate. both of them are about letting the server dip. let's get into it 🫶

✨ NAME ✨

  • roar_exit — let RoarAudio's sound server quit 💀
  • roar_terminate — let RoarAudio's sound server quit as soon as all clients quit 🦋

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

int roar_exit(struct roar_connection * con);

int roar_terminate(struct roar_connection * con, int terminate);

💅 DESCRIPTION 💅

so basically you're asking the sound server to quit. that's the whole vibe. main character move tbh 👑

roar_exit() lets the server quit without waiting for any clients. no thoughts, head empty, just gone. all streams and client connections will be closed cleanly tho — no messy exits, she's classy ✨

roar_terminate() is the patient one. it will let the server quit as soon as all clients disconnects and all input streams ended. the listening socket will be closed. this is useful in case of restarting roard. literally perfect for when you're doing a lil glow-up restart and don't wanna drop anybody mid-stream 🌈

🎀 PARAMETERS 🎀

  • con — an open control connection to the server. it's the lil phone line to your server bestie 📞
  • terminate — wait for all clients to disconnect and all streams to EOF in case of 1. in case of 0, roar_terminate() is equal to roar_exit(). so like, 1 = wait for everyone, 0 = girl bye 👋

⭐ RETURN VALUE ⭐

on success these calls return 0. on error, -1 is returned. simple as that, no cap 💯

🙈 NOTES 🙈

okay important bestie!! even when the call was successful you have to use roar_disconnect(3) to disconnect from the server. the exit call is not the disconnect call, they're two different things, don't skip the second one or it's giving unfinished business 😭

🔥 EXAMPLES 🔥

FIXME

(yeah bestie, the examples section literally just says FIXME. we're all waiting on that one 🙈)

🦋 SEE ALSO 🦋

that's the whole page, you ate it up 💅✨

this lil slice of RoarAudio manual history is dated May 2011, and it comes to you from the RoarAudio source, living under the System Manager's Manual: RoarAudio umbrella. mwah, take care of her 🫶💖

📦 where this page comes from