Current File : //usr/man/man3/ibv_req_notify_cq.3

'\" te
.\" -*- nroff -*-
.\"
.TH IBV_REQ_NOTIFY_CQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
.SH "NAME"
ibv_req_notify_cq \- request completion notification on a completion queue (CQ)
.SH "SYNOPSIS"
.nf
.B #include <infiniband/verbs.h>
.sp
.BI "int ibv_req_notify_cq(struct ibv_cq " "*cq" ", int " "solicited_only" ");
.SH "DESCRIPTION"
.B ibv_req_notify_cq()
requests a completion notification on the completion queue (CQ)
.I cq\fR.
.PP
Upon the addition of a new CQ entry (CQE) to
.I cq\fR,
a completion event will be added to the completion channel associated
with the CQ.
If the argument
.I solicited_only
is zero, a completion event is generated for any new CQE.  If 
.I solicited_only
is non\-zero, an event is only generated for a new CQE with that is
considered "solicited."  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"
.B 
ibv_req_notify_cq()
returns 0 on success, or the value of errno on failure (which indicates the failure reason).

.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	network/open-fabrics
=
Stability	Volatile
.TE 
.PP
.SH "NOTES"
The request for notification is "one shot."  Only one completion event
will be generated for each call to
.B ibv_req_notify_cq()\fR.
.SH "SEE ALSO"
.BR ibv_create_comp_channel (3),
.BR ibv_create_cq (3),
.BR ibv_get_cq_event (3)
.SH "AUTHORS"
.TP
Dotan Barak <dotanb@mellanox.co.il>


.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  ['http://download.oracle.com/otn-pub/oss/networking/libsif-1.0.tar.gz', 'http://www.openfabrics.org/downloads/ibutils/ibutils-1.5.7.tar.gz', 'http://www.openfabrics.org/downloads/libibverbs/libibverbs-1.1.4-1.22.g7257cd3.tar.gz', 'http://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.1-1.18.gb810a27.tar.gz', 'http://www.openfabrics.org/downloads/libsdp/libsdp-1.1.108-0.15.gd7fdb72.tar.gz', 'http://www.openfabrics.org/downloads/management/infiniband-diags-1.5.8.tar.gz', 'http://www.openfabrics.org/downloads/management/libibmad-1.3.7.tar.gz', 'http://www.openfabrics.org/downloads/management/libibumad-1.3.7.tar.gz', 'http://www.openfabrics.org/downloads/management/opensm-3.3.9.tar.gz', 'http://www.openfabrics.org/downloads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'http://www.openfabrics.org/downloads/qperf/qperf-0.4.6-0.1.gb81434e.tar.gz', 'http://www.openfabrics.org/downloads/rdmacm/librdmacm-1.0.14.1.tar.gz', 'http://www.openfabrics.org/downloads/rds-tools/rds-tools-2.0.4.tar.gz']

Further information about this software can be found on the open source community website at http://www.openfabrics.org/.