diff options
Diffstat (limited to 'man/ibv_create_srq.3')
-rw-r--r-- | man/ibv_create_srq.3 | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/man/ibv_create_srq.3 b/man/ibv_create_srq.3 deleted file mode 100644 index 7a826a1..0000000 --- a/man/ibv_create_srq.3 +++ /dev/null @@ -1,67 +0,0 @@ -.\" -*- nroff -*- -.\" -.TH IBV_CREATE_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual" -.SH "NAME" -ibv_create_srq, ibv_destroy_srq \- create or destroy a shared receive queue (SRQ) -.SH "SYNOPSIS" -.nf -.B #include <infiniband/verbs.h> -.sp -.BI "struct ibv_srq *ibv_create_srq(struct ibv_pd " "*pd" ", struct " -.BI " ibv_srq_init_attr " "*srq_init_attr" ); -.sp -.BI "int ibv_destroy_srq(struct ibv_srq " "*srq" ); -.fi -.SH "DESCRIPTION" -.B ibv_create_srq() -creates a shared receive queue (SRQ) associated with the protection domain -.I pd\fR. -The argument -.I srq_init_attr -is an ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>. -.PP -.nf -struct ibv_srq_init_attr { -.in +8 -void *srq_context; /* Associated context of the SRQ */ -struct ibv_srq_attr attr; /* SRQ attributes */ -.in -8 -}; -.sp -.nf -struct ibv_srq_attr { -.in +8 -uint32_t max_wr; /* Requested max number of outstanding work requests (WRs) in the SRQ */ -uint32_t max_sge; /* Requested max number of scatter elements per WR */ -uint32_t srq_limit; /* The limit value of the SRQ (irrelevant for ibv_create_srq) */ -.in -8 -}; -.fi -.PP -The function -.B ibv_create_srq() -will update the -.I srq_init_attr -struct with the original values of the SRQ that was created; the -values of max_wr and max_sge will be greater than or equal to the -values requested. -.PP -.B ibv_destroy_srq() -destroys the SRQ -.I srq\fR. -.SH "RETURN VALUE" -.B ibv_create_srq() -returns a pointer to the created SRQ, or NULL if the request fails. -.PP -.B ibv_destroy_srq() -returns 0 on success, or the value of errno on failure (which indicates the failure reason). -.SH "NOTES" -.B ibv_destroy_srq() -fails if any queue pair is still associated with this SRQ. -.SH "SEE ALSO" -.BR ibv_alloc_pd (3), -.BR ibv_modify_srq (3), -.BR ibv_query_srq (3) -.SH "AUTHORS" -.TP -Dotan Barak <dotanba@gmail.com> |