rpma_peer_delete(3)

📦
version 1.3.0 · 3 versions
, in ubuntu noble

💖 rpma_peer_delete — the RPMA programmer's manual, bestie edition 💖

okay so like, welcome to rpma_peer_delete(3), part of the RPMA Programmer's Manual. yes the same RPMA, remote persistent memory access, the whole thing ✨ pull up a chair 🎀

✨ NAME ✨

rpma_peer_delete — bestie, we are deleting a peer object 💅

🌸 SYNOPSIS 🌸

#include <librpma.h>

struct rpma_peer;
int rpma_peer_delete(struct rpma_peer **peer_ptr);

🦋 DESCRIPTION 🦋

rpma_peer_delete() deletes the peer object. that's it. that's the whole job. it takes your peer and it's like, bye 👋✨

💜 RETURN VALUE 💜

The rpma_peer_delete() function returns 0 on success or a negative error code on failure. and listen — rpm_peer_delete() does not set *peer_ptr value to NULL on failure. 😭

💜 RETURN VALUE 💜

(no fr, it's printed twice in the original, we're keeping both, periodt 👑)

The rpma_peer_delete() function returns 0 on success or a negative error code on failure. rpma_peer_delete() does not set *peer_ptr to NULL on failure. so if it flops, that pointer is still sitting there holding whatever it was holding, do not assume it got nulled out, iykyk 🫶

😭 ERRORS 😭

rpma_peer_delete() can fail with the following error:

  • RPMA_E_PROVIDER — deleting the verbs protection domain failed. the verbs protection domain said no 💀

🌈 SEE ALSO 🌈

rpma_peer_new(3), librpma(7) and https://pmem.io/rpma/ — go read those too, they're iconic, no cap 🧚

this has been RPMA, dated 01 April 2024 — thanks for coming to my ted talk, love u, go delete responsibly 💖🦋🌸🎀✨👑

📦 where this page comes from