.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "IBV_REQ_NOTIFY_CQ" "3" "2006-10-31" "libibverbs" "Libibverbs Programmer\[cq]s Manual"
.hy
.SH NAME
.PP
ibv_req_notify_cq - request completion notification on a completion
queue (CQ)
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <infiniband/verbs.h>

int ibv_req_notify_cq(struct ibv_cq *cq, int solicited_only);
\f[R]
.fi
.SH DESCRIPTION
.PP
\f[B]ibv_req_notify_cq()\f[R] requests a completion notification on the
completion queue (CQ) \f[I]cq\f[R].
.PP
Upon the addition of a new CQ entry (CQE) to \f[I]cq\f[R], a completion
event will be added to the completion channel associated with the CQ.
If the argument \f[I]solicited_only\f[R] is zero, a completion event is
generated for any new CQE.
If \f[I]solicited_only\f[R] is non-zero, an event is only generated for
a new CQE with that is considered \[lq]solicited.\[rq] A CQE is
solicited if it is a receive completion for a message with the Solicited
Event header bit set, or if the status is not successful.
All other successful receive completions, or any successful send
completion is unsolicited.
.SH RETURN VALUE
.PP
\f[B]ibv_req_notify_cq()\f[R] returns 0 on success, or the value of
errno on failure (which indicates the failure reason).
.SH NOTES
.PP
The request for notification is \[lq]one shot.\[rq] Only one completion
event will be generated for each call to \f[B]ibv_req_notify_cq()\f[R].
.SH SEE ALSO
.PP
\f[B]ibv_create_comp_channel\f[R](3), \f[B]ibv_create_cq\f[R](3),
\f[B]ibv_get_cq_event\f[R](3)
.SH AUTHOR
.PP
Dotan Barak <dotanba@gmail.com>