RPMA_PEER_CFG_GET_DESCRIPTOR_SIZE(3)

📦
version 1.3.0 · 3 versions
, in ubuntu noble

💖 rpma_peer_cfg_get_descriptor_size — get size of the peer cfg descriptor 💖

okay bestie, welcome to the RPMA Programmer's Manual, section 3, and today's main character is rpma_peer_cfg_get_descriptor_size 🫶 she's a tiny little function but she knows exactly what she's about, and that is: telling you how big your peer configuration descriptor is. no drama, no plot twists. just size. ✨

🌸 NAME 🌸

rpma_peer_cfg_get_descriptor_size — get size of the peer cfg descriptor 👑

🎀 SYNOPSIS 🎀

#include <librpma.h>

struct rpma_peer_cfg;
int rpma_peer_cfg_get_descriptor_size(const struct rpma_peer_cfg *pcfg, size_t *desc_size);

like. look at her. one include, one forward declaration of struct rpma_peer_cfg, one function signature. clean, minimal, iconic 💅

🦋 DESCRIPTION 🦋

so what does rpma_peer_cfg_get_descriptor_size() actually do? bestie it literally does one thing and it does it well:

  • it gets the size of the peer configuration descriptor 📏

that's it. that's the whole vibe. it's the "how many bytes am I working with here" girlie. no cap. 🌈

⭐ RETURN VALUE ⭐

rpma_peer_cfg_get_descriptor_size() returns 0 on success, or a negative error code on failure 😭

so like, zero = we ate. negative = something went sideways.

💀 ERRORS 💀

rpma_peer_cfg_get_descriptor_size() can fail with the following error:

  • RPMA_E_INVAL — pcfg or desc_size is NULL 🙈
fr fr, check your pointers before you call her. passing a NULL pcfg or a NULL desc_size is giving chaos energy and she will not be having it.

🔥 SEE ALSO 🔥

and that's the whole page bestie, we're done here 💜 this one's from the RPMA crew, dated 01 April 2024 — go forth, get your descriptor size, and slay ✨👑🎀

📦 where this page comes from