.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_conn_wait 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_conn_wait \fP- wait for a completion event on the shared completion channel from CQ or RCQ
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_conn;
      struct rpma_cq
      int \fBrpma_conn_wait\fP(struct rpma_conn *conn, int flags, struct rpma_cq **cq, bool *is_rcq)

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_conn_wait\fP() waits for a completion event on the shared completion channel from CQ or RCQ,
acks it and returns a CQ that caused the event in the cq argument and a boolean value saying if
it is RCQ or not in the is_rcq argument (if is_rcq is not NULL). If \fBrpma_conn_wait\fP() succeeds,
then all available completions should be collected from the returned cq using \fBrpma_cq_get_wc\fP(3).
.SH RETURN VALUE
The \fBrpma_conn_wait\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_conn_wait\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - conn or cq are NULL
.IP \(bu 3
RPMA_E_NOT_SHARED_CHNL - the completion event channel is not shared
.IP \(bu 3
RPMA_E_NO_COMPLETION - \fBibv_get_cq_event\fP(3) failed
.IP \(bu 3
RPMA_E_UNKNOWN - \fBibv_get_cq_event\fP(3) returned unknown CQ
.IP \(bu 3
RPMA_E_PROVIDER - \fBibv_req_notify_cq\fP(3) failed
.SH SEE ALSO
\fBrpma_conn_req_new\fP(3), \fBlibrpma\fP(7) and https://pmem.io/rpma/