vrb_give(3)

📦 version 0.5.1, in nixos 26.05

okay bestie, welcome to vrb_give(3), straight out of the VRB Programmer's Manual ✨. This is the page where you tell your virtual ring buffer how much data you just placed into its empty space, and honestly it’s giving responsible group-chat updater energy 💅.

🎀 NAME 🎀

vrb_give — create a new virtual ring buffer. That’s what the NAME section says, bestie, and we are keeping every detail 👑.

📚 LIBRARY 📚

Link with -lvrb and you’re in business 🫶.

✨ SYNOPSIS ✨

#include <vrb.h>

vrb_p vrb_give(vrb_p vrb, size_t size);

🎀 DESCRIPTION 🎀

So here’s the vibe: by the time you call vrb_give, you’ll have called vrb_empty_len(3) and vrb_empty_ptr(3) to get the length of empty space in the buffer and a pointer to it. Then you placed some data into that space, starting from the pointer you obtained and placing no more than the length you obtained 💖.

vrb_give specifies how much data has been placed into the empty portion of the virtual ring buffer by the caller. It’s literally the “bestie, I wrote this much data into the empty space” update, and the buffer needs it to keep track of what’s data and what’s still empty 🌸.

🌸 ARGUMENTS 🌸

  • vrb_p vrb — specifies which virtual ring buffer. Like, which one are we updating? Main character buffer energy 👑.
  • size_t size — specifies the length of data that has been placed into the virtual ring buffer empty space by the caller. This is the amount you’re reporting, fr fr 🍓.

🔥 RETURN VALUE 🔥

The return type is int — iconic, concise, no notes 💅.

  • On success, 0 is returned. Slay.
  • On error, -1 is returned. Not slay.

💀 ERRORS 💀

If an error is returned, then errno will have one of the following values:

  • EINVAL — an invalid virtual ring buffer pointer was specified. That pointer did not pass the vibe check 😭.
  • ENOSPC — the specified length is greater than the empty space in the virtual ring buffer. You’re trying to report more data than the empty space can hold, and the buffer is literally saying “no space, bestie” 🙈.

🦋 SEE ALSO 🦋

Go read these next, bestie — the whole VRB friend group is here 🌈:

mwah 💋 — this page comes from the vrb source/version, dated 2002-09-30, and it’s literally the vrb_give(3) page. Bye bestie, go give that buffer its length 🫶.

📦 where this page comes from