rpma_conn_disconnect(3)

💖 rpma_conn_disconnect — tear the connection down 💖

okay bestie, welcome to the RPMA Programmer's Manual ✨ this one's rpma_conn_disconnect(3), and no cap, it's the breakup episode of the librpma saga 💅

---

🎀 NAME 🎀

rpma_conn_disconnect — tear the connection down

like. literally. that's the whole job. she serves closure 🦋

---

✨ SYNOPSIS ✨

#include <librpma.h>

struct rpma_conn;
int rpma_conn_disconnect(struct rpma_conn *conn);

so you grab librpma.h, you've got your struct rpma_conn floating around, and you call rpma_conn_disconnect() on it with a pointer to your conn. that's the move 🫶

---

🌸 DESCRIPTION 🌸

rpma_conn_disconnect() tears the connection down. that's it. that's the vibe. it's giving "we need to talk" but make it RDMA 😭

the way it works is, there are two whole moods it can be in:

• It may initiate disconnecting the connection. in that case, the end of disconnecting is signalled by the RPMA_CONN_CLOSED event via rpma_conn_next_event() — so you don't just get closure, you get a notification that closure happened 👑
• It may be called after receiving the RPMA_CONN_CLOSED event. in this case, the disconnection is done when rpma_conn_disconnect() returns with success. so if you already got the event, the moment this call comes back good, it's over over. periodt 💀

---

💜 RETURN VALUE 💜

rpma_conn_disconnect() returns 0 on success or a negative error code on failure.

zero = slay, negative = not slay 🙈

---

🔥 ERRORS 🔥

rpma_conn_disconnect() can fail with the following errors, and bestie you will be checking these:

• RPMA_E_INVAL — conn is NULL 💀 like girl. you passed nothing. there's no connection to tear down. what are we doing
• RPMA_E_PROVIDER — rdma_disconnect() failed 😭 the underlying provider said no

fr fr, always check the return value. a silent failed disconnect is main character energy in the worst possible way.

---

🌈 SEE ALSO 🌈

• rpma_conn_delete(3)
• rpma_conn_next_event(3)
• rpma_conn_req_connect(3)
• librpma(7)
• and the whole site: https://pmem.io/rpma/

---

RPMA · version vibes from the RPMA Programmer's Manual, dated 01 April 2024 — that's the tea, bestie, go disconnect responsibly 🎀✨💖