RPMA_MR_REMOTE_GET_FLUSH_TYPE(3)

💖 rpma_mr_remote_get_flush_type — the remote MR flush-type getter, bestie edition 💖

okay so we're in the RPMA Programmer's Manual and today's main character is rpma_mr_remote_get_flush_type, a little function that tells you which flush types a remote memory region has going for it. no cap, that's the whole vibe. 🦋

---

✨ NAME ✨

rpma_mr_remote_get_flush_type — get a remote memory region's flush types

like, literally what it says on the tin. 💅

---

🎀 SYNOPSIS 🎀

#include <librpma.h>

struct rpma_mr_remote;
int rpma_mr_remote_get_flush_type(const struct rpma_mr_remote *mr, int *flush_type);

copy that exactly, bestie, don't be out here freehanding the signature 🙈

---

🌸 DESCRIPTION 🌸

so basically rpma_mr_remote_get_flush_type() gets the flush types that the remote memory region supports. that's it. that's the function. she's a getter, she's lowkey iconic for it, she does one job and she does it well. ✨

---

👑 RETURN VALUE 👑

rpma_mr_remote_get_flush_type() returns 0 on success, or a negative error code on failure. and listen — on failure she does not set the *flush_type value. not even a little. so don't go reading that variable hoping for crumbs, because you will get nothing. 😭

---

💀 ERRORS 💀

rpma_mr_remote_get_flush_type() can fail with the following error:

• RPMA_E_INVAL — mr or flush_type is NULL. bestie. you passed a null. the vibe check failed. 🫠

---

🌈 SEE ALSO 🌈

• rpma_mr_remote_from_descriptor(3)
• librpma(7)
• https://pmem.io/rpma/

go read those too, iykyk 🧚

---

okay and one lil sign-off because you deserve it: this lil slice of documentation is from RPMA, dated 01 April 2024, and it's the rpma_mr_remote_get_flush_type(3) page, fr fr. mwah. go forth and flush responsibly. 💜🎀🦋