contrib/ofed/libibverbs/man/ibv_query_srq.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_QUERY_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_query_srq \- get the attributes of a shared receive queue (SRQ)
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/verbs.h>
   9 .sp
  10 .BI "int ibv_query_srq(struct ibv_srq " "*srq" ", struct ibv_srq_attr " "*srq_attr" );
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B ibv_query_srq()
  14 gets the attributes of the SRQ
  15 .I srq
  16 and returns them through the pointer
  17 .I srq_attr\fR.
  18 The argument
  19 .I srq_attr
  20 is an ibv_srq_attr struct, as defined in <infiniband/verbs.h>.
  21 .PP
  22 .nf
  23 struct ibv_srq_attr {
  24 .in +8
  25 uint32_t                max_wr;         /* maximum number of outstanding work requests (WRs) in the SRQ */
  26 uint32_t                max_sge;        /* maximum number of scatter elements per WR */
  27 uint32_t                srq_limit;      /* the limit value of the SRQ */
  28 .in -8
  29 };
  30 .fi
  31 .SH "RETURN VALUE"
  32 .B ibv_query_srq()
  33 returns 0 on success, or the value of errno on failure (which indicates the failure reason).
  34 .SH "NOTES"
  35 If the value returned for srq_limit is 0, then the SRQ limit reached
  36 ("low watermark") event is not (or no longer) armed, and no
  37 asynchronous events will be generated until the event is rearmed.
  38 .SH "SEE ALSO"
  39 .BR ibv_create_srq (3),
  40 .BR ibv_destroy_srq (3),
  41 .BR ibv_modify_srq (3)
  42 .SH "AUTHORS"
  43 .TP
  44 Dotan Barak <dotanb@mellanox.co.il>