Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ibv_req_notify_cq (3)

Name

ibv_req_notify_cq - request completion notification on a completion queue (CQ)

Synopsis

#include <infiniband/verbs.h>

int ibv_req_notify_cq(struct ibv_cq *cq, int solicited_only);

Description

Libibverbs Programmer's Manual                            IBV_REQ_NOTIFY_CQ(3)



NAME
       ibv_req_notify_cq  -  request  completion  notification on a completion
       queue (CQ)

SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_req_notify_cq(struct ibv_cq *cq, int solicited_only);

DESCRIPTION
       ibv_req_notify_cq() requests a completion notification on  the  comple-
       tion queue (CQ) cq.

       Upon  the  addition  of  a new CQ entry (CQE) to cq, a completion event
       will be added to the completion channel associated with the CQ.  If the
       argument  solicited_only  is  zero, a completion event is generated for
       any new CQE.  If 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 success-
       ful receive completions, or any successful  send  completion  is  unso-
       licited.

RETURN VALUE
       ibv_req_notify_cq()  returns  0  on  success,  or the value of errno on
       failure (which indicates the failure reason).


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       The request for notification is "one shot."  Only one completion  event
       will be generated for each call to ibv_req_notify_cq().

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded   from    ['https://www.openfabrics.org/down-
       loads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz', 'https://www.openfab-
       rics.org/downloads/libibverbs/libibverbs-1.1.8.tar.gz',
       'https://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.6.tar.gz',
       'https://www.openfabrics.org/downloads/libsdp/lib-
       sdp-1.1.108-0.15.gd7fdb72.tar.gz',   'https://www.openfabrics.org/down-
       loads/management/infiniband-diags-1.6.5.tar.gz',  'https://www.openfab-
       rics.org/downloads/management/libibmad-1.3.12.tar.gz',
       'https://www.openfabrics.org/downloads/management/libibu-
       mad-1.3.10.2.tar.gz',    'https://www.openfabrics.org/downloads/manage-
       ment/opensm-3.3.19.tar.gz',          'https://www.openfabrics.org/down-
       loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'https://www.open-
       fabrics.org/downloads/qperf/qperf-0.4.9.tar.gz',  'https://www.openfab-
       rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',  'https://www.open-
       fabrics.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/.

SEE ALSO
       ibv_create_comp_channel(3), ibv_create_cq(3), ibv_get_cq_event(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>




libibverbs                        2006-10-31              IBV_REQ_NOTIFY_CQ(3)