LC_CHANNE..._OVERHEAD(3)

πŸ’– LC_CHANNE..._OVERHEAD(3) β€” aka the "how many extra packets are we yeeting" page πŸ’–

okay so bestie, welcome to the Librecast Programmer's Manual πŸ¦‹ (that's the manual name, it lives up here at the top, consider it folded in and living its best life ✨). Today's episode: how many overhead packets your RaptorQ setup is gonna send. Buckle up, it's giving very specific and very important. πŸŽ€


✨ NAME ✨

lc_ctx_coding_set, lc_channel_rq_overhead β€” set Librecast RaptorQ overhead packets.

ngl, the NAME line says lc_ctx_coding_set while the SYNOPSIS down there says lc_ctx_rq_overhead πŸ‘€ β€” we're just reporting what's on the page, no editing, no fixing, that's the rule. πŸ’…

πŸ“š LIBRARY πŸ“š

Librecast library (liblibrecast, -llibrecast). That's the one, that's the vibe. 🫢


🌈 SYNOPSIS 🌈

#include <librecast/net.h>

int lc_ctx_rq_overhead(lc_ctx_t *ctx, int overhead);
int lc_channel_rq_overhead(lc_channel_t *chan, int overhead);

Compile and link with -llibrecast. Don't forget it, it will simply not work and you will simply cry 😭


πŸ’… DESCRIPTION πŸ’…

so here's the tea, two whole functions, both obsessed with overhead:

  • lc_ctx_rq_overhead() β€” sets the default overhead packets for channels that get created subsequently using the context ctx. Like, it's setting the vibe for all the babies that come after 🐣
  • lc_channel_rq_overhead() β€” sets RaptorQ overhead packets for a Librecast channel, chan, and it overrides any defaults it inherited from the parent Librecast context. main character energy, honestly πŸ‘‘

chan is a pointer to a Librecast channel. yes, a pointer. yes, you have to deal with that. ✨

the overhead argument is the number of overhead packets to send in a single call to lc_channel_send(3) or lc_channel_sendmsg(3). the way that one number controls so much...

  • if overhead is >= 0, then a single call to a sending function with LC_CODE_FEC_RQ enabled will cause K' + overhead packets to be sent. slay πŸ’–
  • if overhead is < 0, then no automatic sending will occur. periodt. nothing goes out automatically, that's the whole rule πŸ™ˆ

πŸŽ€ RETURN VALUE πŸŽ€

Returns the new overhead value. that's it, that's the return. short and iconic πŸ’«


πŸ’€ ERRORS πŸ’€

None. literally none. a flawless, error-free queen. πŸ‘‘


πŸ”₯ SEE ALSO πŸ”₯

go read those too, bestie, iykyk πŸ“–βœ¨


and that's a wrap!! this whole page is brought to you by LIBRECAST, dated 2025-03-24 🌸 β€” and yes the footer also says LC_CHANNE..._OVERHEAD(3) again because it's extra like that πŸ’… mwah, go forth and set your overhead πŸ’–πŸ¦‹πŸ§š

πŸ“¦ where this page comes from