rpma_conn_wait(3)

💖 rpma_conn_wait — RPMA Programmer's Manual 💖

okay bestie, gather round, because this is a function from the librpma page of the RPMA Programmer's Manual and she is lowkey the whole vibe of your completion handling. no cap. 🦋

---

✨ NAME ✨

rpma_conn_wait — wait for a completion event on the shared completion channel from CQ or RCQ 🫶

---

🌸 SYNOPSIS 🌸

#include <librpma.h>

struct rpma_conn;
struct rpma_cq
int rpma_conn_wait(struct rpma_conn *conn, int flags, struct rpma_cq **cq, bool *is_rcq)

---

🎀 DESCRIPTION 🎀

so what does rpma_conn_wait() actually do? bestie, she waits. 💅

She waits for a completion event on the shared completion channel from CQ or RCQ, acks it, and then hands you back the CQ that caused the event — that lands in the cq argument — plus a boolean telling you whether it's RCQ or not, which lands in the is_rcq argument (and that only happens if is_rcq is not NULL, iykyk).

and here's the part you cannot skip, bestie: if rpma_conn_wait() succeeds, then all available completions should be collected from the returned cq using rpma_cq_get_wc(3). all of them. not some. all. the way that she sets you up and expects you to finish the job is honestly main character energy. 👑

---

⭐ RETURN VALUE ⭐

rpma_conn_wait() returns 0 on success, or a negative error code on failure. simple as that. 🍓

---

💀 ERRORS 💀

rpma_conn_wait() can fail with the following errors, and no we are not sugarcoating any of them:

• RPMA_E_INVAL — conn or cq are NULL 🙈
• RPMA_E_NOT_SHARED_CHNL — the completion event channel is not shared 😭
• RPMA_E_NO_COMPLETION — ibv_get_cq_event(3) failed 💀
• RPMA_E_UNKNOWN — ibv_get_cq_event(3) returned unknown CQ 🤨
• RPMA_E_PROVIDER — ibv_req_notify_cq(3) failed 🔥

fr fr, if you see RPMA_E_NOT_SHARED_CHNL it's giving "you called this on a channel that isn't shared" and there is no workaround in this page, so go check your setup bestie.

---

🌈 SEE ALSO 🌈

• rpma_conn_req_new(3)
• librpma(7)
• <https://pmem.io/rpma/> — yes it's a URL, keep it in your back pocket 💜

---

that's the whole page, bestie, go collect those completions 💅✨

with love from the RPMA crew, 01 April 2024 — mwah, slay, periodt 🎀🦋💖