.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_cq_wait 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_cq_wait \fP- wait for a completion and ack it
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_cq;
      int \fBrpma_cq_wait\fP(struct rpma_cq *cq);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_cq_wait\fP() waits for an incoming completion event and acks it. If \fBrpma_cq_wait\fP() succeeds,
then all available completions should be collected using \fBrpma_cq_get_wc\fP(3) before the next
\fBrpma_cq_wait\fP() call.
.SH RETURN VALUE
The \fBrpma_cq_wait\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_cq_wait\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - cq is NULL
.IP \(bu 3
RPMA_E_PROVIDER - \fBibv_req_notify_cq\fP(3) failed with a provider error
.IP \(bu 3
RPMA_E_NO_COMPLETION - no completions available
.IP \(bu 3
RPMA_E_SHARED_CHANNEL - the completion event channel is shared and cannot be handled by any
particular CQ
.SH SEE ALSO
\fBrpma_conn_get_cq\fP(3), \fBrpma_conn_get_rcq\fP(3), \fBrpma_cq_get_wc\fP(3), \fBrpma_cq_get_fd\fP(3), \fBlibrpma\fP(7) and
https://pmem.io/rpma/