rpma_mr_get_descriptor(3)

💖 rpma_mr_get_descriptor(3) 💖

okay bestie, welcome to the RPMA Programmer's Manual ✨ we're doing rpma_mr_get_descriptor today and honestly? she's a baddie.

---

🌸 NAME 🌸

rpma_mr_get_descriptor — get a descriptor of a memory region 🧚

---

✨ SYNOPSIS ✨

#include <librpma.h>

struct rpma_mr_local;
int rpma_mr_get_descriptor(const struct rpma_mr_local *mr, void *desc);

---

💅 DESCRIPTION 💅

so the way this works: rpma_mr_get_descriptor() writes a network-transferable description of the local memory region you hand it — and that description is literally called the descriptor. 🎀

once you've shipped that descriptor over to the other side, it should get decoded by rpma_mr_remote_from_descriptor() to create a remote memory region's structure, which is what unlocks Remote Memory Access. it's giving teamwork fr fr. 🫶

if you want the full lore, go read librpma(7) — she has details. 👑

---

🚨 SECURITY WARNING 🚨

no cap, this part matters — see rpma_mr_remote_from_descriptor(3). 👀

---

🌈 RETURN VALUE 🌈

rpma_mr_get_descriptor() returns 0 on success, or a negative error code if it's not feeling it. 😭

---

💀 ERRORS 💀

rpma_mr_get_descriptor() can fail with the following error:

• RPMA_E_INVAL — mr or desc is NULL 🙈

---

🦋 SEE ALSO 🦋

• rpma_mr_get_descriptor_size(3)
• rpma_mr_reg(3)
• librpma(7)
• <https://pmem.io/rpma/> — wait, no links, but that URL is in the original so here it is as plain text: https://pmem.io/rpma/ ✨

---

periodt. that's the whole page, bestie. go get that descriptor. 💜

RPMA · 01 April 2024 · rpma_mr_get_descriptor(3) — mwah, catch you in the next manpage, iykyk 💅💖