rpma_conn_next_event(3)

📦
version 1.3.0 · 3 versions
, in ubuntu noble

✨ rpma_conn_next_event ✨

okay so bestie, welcome to rpma_conn_next_event(3) — that's section 3 of the RPMA Programmer's Manual, and yes we're reading a manpage together, it's giving study date energy 💖

🌸 NAME 🌸

rpma_conn_next_event — obtain a connection status 👀

like… you wanna know what your connection is doing? this is the girl for the job.

🎀 SYNOPSIS 🎀

#include <librpma.h>

struct rpma_conn;
enum rpma_conn_event {
        RPMA_CONN_UNDEFINED = -1,
        RPMA_CONN_ESTABLISHED,
        RPMA_CONN_CLOSED,
        RPMA_CONN_LOST,
        RPMA_CONN_REJECTED,
        RPMA_CONN_UNREACHABLE
};

int rpma_conn_next_event(struct rpma_conn *conn,
                enum rpma_conn_event *event);

no cap, that's the whole vibe right there 💅

🦋 DESCRIPTION 🦋

rpma_conn_next_event() obtains the next event from the connection. literally just the next one, bestie — one at a time, main character pacing, we love that for us ✨

Types of events:

  • RPMA_CONN_UNDEFINED — undefined connection event 🙈 (it's giving mystery, but not in a cute way)
  • RPMA_CONN_ESTABLISHED — connection established 👑 the slay era begins
  • RPMA_CONN_CLOSED — connection closed 🎀 a peaceful goodbye
  • RPMA_CONN_LOST — connection lost 😭 where did she GO
  • RPMA_CONN_REJECTED — connection rejected 💀 oof
  • RPMA_CONN_UNREACHABLE — connection unreachable 🦋 can't get there from here, bestie

⭐ RETURN VALUE ⭐

The rpma_conn_next_event() function returns 0 on success or a negative error code on failure.

so 0 = we ate 🔥, negative = we did NOT eat 😭

💅 ERRORS 💅

rpma_conn_next_event() can fail with the following errors:

  • RPMA_E_INVAL — conn or event is NULL 🚩
  • RPMA_E_UNKNOWN — unexpected event 👀 plot twist nobody asked for
  • RPMA_E_PROVIDER — rdma_get_cm_event() or rdma_ack_cm_event() failed 💀 not our fault, the provider did it
  • RPMA_E_NOMEM — out of memory 😭 brain empty

🌈 SEE ALSO 🌈

iykyk — go read those next, bestie, the lore is deep 🫶

RPMA · version vibes from 01 April 2024 · rpma_conn_next_event(3) — and that's the whole page, periodt 🎀✨💖

📦 where this page comes from