RQ_INIT(3)

💖 NAME 💖

rq_init, rq_free — bestie, these are the ones that make a RaptorQ context and then let it go 💅

✨ SYNOPSIS ✨

#include <lcrq.h>

rq_t *rq_init(const uint64_t F, const uint16_t T);
void rq_free(rq_t *rq);

Compile and link with -llcrq, okurrr? 🫶

🌸 DESCRIPTION 🌸

rq_init() spins up a brand new RaptorQ context and gets the whole environment set up. Like, it's giving main character energy for your encode session. 👑

Here's what you're handing it:

• F — the size of the object you wanna encode. This has to be a positive integer, and it maxes out at 946270874880. No cap, that's the ceiling. 🚫
• T — the symbol size. Usually this is literally just the size of the packet payload you're planning to send. And listen: this one must be a multiple of the Alignment parameter, which is 4. Periodt. Don't argue with me on this one. 💅

When you're done-done? Call rq_free(3) — she deserves her rest. 😌

rq_free() invalidates and frees a RaptorQ context that you made with rq_init(3). Gone. Poof. 🦋

🎀 RETURN VALUE 🎀

rq_init() hands you back a pointer to an rq_t handle. Iconic. ✨ But if things go sideways it returns NULL and sets errno to ENOMEM. 💀

The rq_free() function returns... nothing. No value. It's a void girly. She simply exits. 🙈

🔥 ERRORS 🔥

rq_init() can fail with the following error:

• ENOMEM — Out of memory 😭. Possibly, the application hit the RLIMIT_AS or RLIMIT_DATA limit described in getrlimit(2). Like, it ran out of room bestie, it's not that deep.

🧚 EXAMPLE 🧚

💜 Program source

rq_t *rq;
rq = rq_init(filesize, 1024);

/* your program here */

rq_free(rq); /* free context when done */

See that? Init, do your lil thing, free. Clean. Tidy. Ate. 🍓

🌈 SEE ALSO 🌈

rq_encode(3), rq_decode(3), rq_symbol(3), lcrq(7)

okay that's the whole page, you're literally a RaptorQ girlie now 💖✨

this was brought to you by the Librecast Programmer's Manual, LCRQ edition, dated 2022-07-07 — mwah, slay, bye 🎀