rpma_srq_get_rcq(3)

💖 rpma_srq_get_rcq — bestie edition 💖

okay so real quick, this page lives in the RPMA Programmer's Manual (section 3, rpma_srq_get_rcq(3), iykyk) and it's literally just about grabbing the receive CQ out of your shared RQ object. tiny page, big vibes, no cap.

---

✨ NAME ✨

rpma_srq_get_rcq — get the receive CQ from the shared RQ object 🎀

---

🌸 SYNOPSIS 🌸

#include <librpma.h>

struct rpma_srq;
struct rpma_cq;
int rpma_srq_get_rcq(const struct rpma_srq *srq, struct rpma_cq **rcq_ptr);

like. that's the whole thing. she's short and she's iconic 💅

---

🦋 DESCRIPTION 🦋

okay so rpma_srq_get_rcq() gets the receive CQ from the shared RQ object. that's the assignment. that's the mission. 🫶

and the lore is: the receive CQ was created by rpma_srq_new(3), and it's the thing that allows handling all rpma_srq_recv(3) completions within the shared RQ. so every recv completion in that shared RQ flows through here. periodt.

also bestie, if you want a different size for that receive CQ, rpma_srq_cfg_set_rcq_size(3) can change the receive CQ size. go off, configure your little heart out ✨

---

🌈 RETURN VALUE 🌈

rpma_srq_get_rcq() returns 0 on success or a negative error code on failure. simple as that, no plot twist.

💀 important though: rpma_srq_get_rcq() does not set the *rcq_ptr value on failure. like, it just leaves it alone. do not go reading it and assuming things, fr fr.

---

💜 ERRORS 💜

rpma_srq_get_rcq() can fail with the following error:

• RPMA_E_INVAL — srq or rcq_ptr is NULL 🚫

that's the one. the only one. guard your pointers, queen 👑

---

🧚 SEE ALSO 🧚

• rpma_cq_wait(3)
• rpma_cq_get_wc(3)
• rpma_cq_get_fd(3)
• rpma_srq_cfg_set_rcq_size(3)
• rpma_srq_new(3)
• librpma(7)
• https://pmem.io/rpma/

---

and that's the whole page, bestie!! this one's from the RPMA crew, dated 01 April 2024, and it's filed under rpma_srq_get_rcq(3). mwah, go get that CQ 💋💖✨