File: ibv_req_notify_cq.3.md

package info (click to toggle)
rdma-core 33.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 13,844 kB
  • sloc: ansic: 145,804; python: 5,688; sh: 2,761; perl: 1,465; makefile: 73
file content (55 lines) | stat: -rw-r--r-- 1,516 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
date: 2006-10-31
footer: libibverbs
header: "Libibverbs Programmer's Manual"
layout: page
license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md'
section: 3
title: IBV_REQ_NOTIFY_CQ
---

# NAME

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

# SYNOPSIS

```c
#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 completion
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 successful receive completions, or any
successful send completion is unsolicited.

# RETURN VALUE

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

# NOTES

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

# SEE ALSO

**ibv_create_comp_channel**(3),
**ibv_create_cq**(3),
**ibv_get_cq_event**(3)

# AUTHOR

Dotan Barak <dotanba@gmail.com>