contrib/ofed/libibverbs/man/ibv_req_notify_cq.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_REQ_NOTIFY_CQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_req_notify_cq \- request completion notification on a completion queue (CQ)
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/verbs.h>
   9 .sp
  10 .BI "int ibv_req_notify_cq(struct ibv_cq " "*cq" ", int " "solicited_only" ");
  11 .SH "DESCRIPTION"
  12 .B ibv_req_notify_cq()
  13 requests a completion notification on the completion queue (CQ)
  14 .I cq\fR.
  15 .PP
  16 Upon the addition of a new CQ entry (CQE) to
  17 .I cq\fR,
  18 a completion event will be added to the completion channel associated
  19 with the CQ.
  20 If the argument
  21 .I solicited_only
  22 is zero, a completion event is generated for any new CQE.  If
  23 .I solicited_only
  24 is non\-zero, an event is only generated for a new CQE with that is
  25 considered "solicited."  A CQE is solicited if it is a receive
  26 completion for a message with the Solicited Event header bit set, or
  27 if the status is not successful.  All other successful receive
  28 completions, or any successful send completion is unsolicited.
  29 .SH "RETURN VALUE"
  30 .B
  31 ibv_req_notify_cq()
  32 returns 0 on success, or the value of errno on failure (which indicates the failure reason).
  33 .SH "NOTES"
  34 The request for notification is "one shot."  Only one completion event
  35 will be generated for each call to
  36 .B ibv_req_notify_cq()\fR.
  37 .SH "SEE ALSO"
  38 .BR ibv_create_comp_channel (3),
  39 .BR ibv_create_cq (3),
  40 .BR ibv_get_cq_event (3)
  41 .SH "AUTHORS"
  42 .TP
  43 Dotan Barak <dotanb@mellanox.co.il>