iob_new(3)

✨ NAME ✨

iob_new — create new I/O batch. This is iob_new(3) from the Library Functions Manual, and we are literally so back bestie 🫶💅

🌸 SYNTAX 🌸

#include <libowfat/iob.h>

io_batch* iob_new(int hint_entries);

💖 DESCRIPTION 💖

okay so iob_new creates a new I/O batch with enough space allocated for hint_entries entries (buffers or files). This is purely a performance hint — no secret meaning, no lore — so if you are unsure, just pass 1 and move on ✨.

You can add buffers, strings and files to an I/O batch and then send it all at once using iob_send. It's giving "gather everything, then send it together" energy 🎀.

The benefit of the I/O batch API is that it exploits platform specific APIs like FreeBSD's sendfile. The file contents will always be sent in a way that allows the operating systems to perform zero copy TCP, and the buffers will always be sent using as few syscalls as possible and avoiding unnecessary copying (using writev). That's the whole point and it ate 🔥.

🦋 RETURN VALUE 🦋

iob_new returns a pointer to an I/O batch data structure. If there was a memory allocation error, it returns NULL instead. So yeah, check that pointer before you start acting brand new 😭.

🎀 SEE ALSO 🎀

• iob_reset(3)
• iob_send(3)
• iob_addbuf(3)
• iob_adds_free(3)
• iob_addfile(3)

---

that's the whole page from the Library Functions Manual — iob_new(3) — and the footer just says iob_new(3) again, with no date listed, so that's the cute little sign-off bestie 🫶💜