.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_srq_new 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_srq_new \fP- create a new shared RQ object
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_peer;
      struct rpma_srq_cfg;
      struct rpma_srq;
      int \fBrpma_srq_new\fP(struct rpma_peer *peer, const struct rpma_srq_cfg *cfg,
                      struct rpma_srq **srq_ptr);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_srq_new\fP() creates a new shared RQ object including a new shared RQ and a new shared receive
CQ. It does not create the shared receive CQ if the size of the receive CQ in cfg equals 0.
.SH RETURN VALUE
The \fBrpma_srq_new\fP() function returns 0 on success or a negative error code on failure.
\fBrpma_srq_new\fP() does not set *srq_ptr value on failure. If cfg is NULL, then the default values
are used
.IP \(bu 3
see \fBrpma_srq_cfg_new\fP(3) for more details.
.SH ERRORS
\fBrpma_srq_new\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - peer or srq_ptr is NULL
.IP \(bu 3
RPMA_E_NOMEM - out of memory
.IP \(bu 3
RPMA_E_PROVIDER - \fBibv_create_srq\fP(3), \fBibv_create_comp_channel\fP(3), \fBibv_create_cq\fP(3) or
\fBibv_req_notify_cq\fP(3) failed
.SH SEE ALSO
\fBrpma_srq_delete\fP(3), \fBrpma_srq_get_rcq\fP(3), \fBlibrpma\fP(7) and https://pmem.io/rpma/