rpma_mr_remote_get_size(3)

πŸ“¦
version 1.3.0 Β· 3 versions
, in ubuntu noble

πŸ’– rpma_mr_remote_get_size β€” get a remote memory region size πŸ’–

okay bestie, so this one is a page from the RPMA Programmer's Manual, section 3, and it's all about rpma_mr_remote_get_size(3). yes the whole page is literally named after one function. it's giving main character energy and honestly? deserved. πŸŽ€


✨ NAME ✨

rpma_mr_remote_get_size β€” get a remote memory region size πŸ¦‹


✨ SYNOPSIS ✨

#include <librpma.h>

struct rpma_mr_remote;
int rpma_mr_remote_get_size(const struct rpma_mr_remote *mr,
                size_t *size);

like. look at that. two lines and a struct forward declaration. so clean, so demure. 🌸


✨ DESCRIPTION ✨

so what does rpma_mr_remote_get_size() actually do, you ask? bestie it gets the size of the remote memory region. that's it. that's the whole job. no cap. 🫢

you hand it your remote memory region and it tells you how big it is. iconic behaviour, truly. πŸ’…


✨ RETURN VALUE ✨

  • rpma_mr_remote_get_size() returns 0 on success β€” slay πŸ’š
  • or a negative error code on failure β€” not slay 😭
⚠️ important bestie: on failure, rpma_mr_remote_get_size() does not set the *size value. so don't go reading it thinking you got data, because you did not. πŸ™ˆ

✨ ERRORS ✨

rpma_mr_remote_get_size() can fail with the following error:

  • RPMA_E_INVAL β€” mr or size is NULL πŸ’€ (yeah, pass a real pointer, bestie, we've all been there)

✨ SEE ALSO ✨


and that's the whole vibe check, bestie. this page came straight out of the RPMA Programmer's Manual, dated 01 April 2024, and yes it's literally titled rpma_mr_remote_get_size(3). go forth and get those remote memory region sizes. periodt. πŸ‘‘βœ¨πŸŒˆ

πŸ“¦ where this page comes from