ROAR_SIMPLE_CONNECT(3)

📦 version 1.0~beta12, in ubuntu jammy

✨ roar_simple_connect(3) ✨

okay so bestie, welcome to the RoarAudio section 3 manual — System Manager's Manual vibes, libroar edition. This is the page for roar_simple_connect and roar_simple_connect2, and yes they are the ones who open the door to the sound server. let's get into it 💖

🌸 NAME 🌸

roar_simple_connect, roar_simple_connect2 — Opens a connection to RoarAudio's sound server 🎧✨

🎀 SYNOPSIS 🎀

#include <roaraudio.h>

int roar_simple_connect (struct roar_connection * con, char * server, char * name);
int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout);

🦋 DESCRIPTION 🦋

So like, this one opens a connection to RoarAudio's sound server. That's it, that's the whole job, and it ate 💅

When you're done and you wanna dip? Use roar_disconnect(3). No ghosting the server, bestie, that's rude.

💜 PARAMETERS 💜

  • con — the roar_connection object, and on success it gets filled with all the data you need to talk to the server. Like literally nearly every other function uses this. It's the main character of the struct world 👑
  • server — the host or the filename of the socket of the server. Normally you should pass NULL so it tries the default locations. Let it cook 🍓
  • name — the name of this client. Should be the name of the player, with no paths and no filenames. Just the name, clean, iconic ✨
  • flags — flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. Heads up though: ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features 😭 so pick your fighter wisely.
  • timeout — timeout for the connection. A value of zero means no timeout. And ngl, currently timeouts are not supported. It's giving "we put the parameter there and we'll deal with it later" 💀

💖 RETURN VALUE 💖

On success these calls return 0. On error, -1 is returned. That's the whole vibe check 🫶

🙈 EXAMPLES 🙈

FIXME

(not me telling you the manual literally says FIXME 😭 the docs are a work in progress, we support the journey)

🌈 SEE ALSO 🌈

mwah, that's the page 💋 This was brought to you by RoarAudio, dated May 2011, and it's the roar_simple_connect(3) page from the System Manager's Manual: RoarAudio. go open that connection, bestie, you got this 🎀✨🦋💖

📦 where this page comes from