.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_conn_next_event 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_conn_next_event \fP- obtain a connection status
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

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

      int \fBrpma_conn_next_event\fP(struct rpma_conn *conn,
                      enum rpma_conn_event *event);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_conn_next_event\fP() obtains the next event from the connection.
Types of events:
.IP \(bu 3
RPMA_CONN_UNDEFINED - undefined connection event
.IP \(bu 3
RPMA_CONN_ESTABLISHED - connection established
.IP \(bu 3
RPMA_CONN_CLOSED - connection closed
.IP \(bu 3
RPMA_CONN_LOST - connection lost
.IP \(bu 3
RPMA_CONN_REJECTED - connection rejected
.IP \(bu 3
RPMA_CONN_UNREACHABLE - connection unreachable
.SH RETURN VALUE
The \fBrpma_conn_next_event\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_conn_next_event\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - conn or event is NULL
.IP \(bu 3
RPMA_E_UNKNOWN - unexpected event
.IP \(bu 3
RPMA_E_PROVIDER - \fBrdma_get_cm_event\fP() or \fBrdma_ack_cm_event\fP() failed
.IP \(bu 3
RPMA_E_NOMEM - out of memory
.SH SEE ALSO
\fBrpma_conn_req_connect\fP(3), \fBrpma_conn_disconnect\fP(3), \fBlibrpma\fP(7) and https://pmem.io/rpma/