summaryrefslogtreecommitdiff
path: root/static/freebsd/man3/ibv_query_srq.3
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man3/ibv_query_srq.3')
-rw-r--r--static/freebsd/man3/ibv_query_srq.345
1 files changed, 45 insertions, 0 deletions
diff --git a/static/freebsd/man3/ibv_query_srq.3 b/static/freebsd/man3/ibv_query_srq.3
new file mode 100644
index 00000000..8a35ce03
--- /dev/null
+++ b/static/freebsd/man3/ibv_query_srq.3
@@ -0,0 +1,45 @@
+.\" -*- nroff -*-
+.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
+.\"
+.TH IBV_QUERY_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
+.SH "NAME"
+ibv_query_srq \- get the attributes of a shared receive queue (SRQ)
+.SH "SYNOPSIS"
+.nf
+.B #include <infiniband/verbs.h>
+.sp
+.BI "int ibv_query_srq(struct ibv_srq " "*srq" ", struct ibv_srq_attr " "*srq_attr" );
+.fi
+.SH "DESCRIPTION"
+.B ibv_query_srq()
+gets the attributes of the SRQ
+.I srq
+and returns them through the pointer
+.I srq_attr\fR.
+The argument
+.I srq_attr
+is an ibv_srq_attr struct, as defined in <infiniband/verbs.h>.
+.PP
+.nf
+struct ibv_srq_attr {
+.in +8
+uint32_t max_wr; /* maximum number of outstanding work requests (WRs) in the SRQ */
+uint32_t max_sge; /* maximum number of scatter elements per WR */
+uint32_t srq_limit; /* the limit value of the SRQ */
+.in -8
+};
+.fi
+.SH "RETURN VALUE"
+.B ibv_query_srq()
+returns 0 on success, or the value of errno on failure (which indicates the failure reason).
+.SH "NOTES"
+If the value returned for srq_limit is 0, then the SRQ limit reached
+("low watermark") event is not (or no longer) armed, and no
+asynchronous events will be generated until the event is rearmed.
+.SH "SEE ALSO"
+.BR ibv_create_srq (3),
+.BR ibv_destroy_srq (3),
+.BR ibv_modify_srq (3)
+.SH "AUTHORS"
+.TP
+Dotan Barak <dotanba@gmail.com>