.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_conn_req_connect 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_conn_req_connect \fP- initiate processing the connection request
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_conn_req;
      struct rpma_conn_private_data;
      struct rpma_conn;
      int \fBrpma_conn_req_connect\fP(struct rpma_conn_req **req_ptr,
                      const struct rpma_conn_private_data *pdata, struct rpma_conn **conn_ptr);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_conn_req_connect\fP() initiates processing the connection requests both incoming and outgoing.
The end of processing is signalled by the RPMA_CONN_ESTABLISHED event via
\fBrpma_conn_next_event\fP().
.SH RETURN VALUE
The \fBrpma_conn_req_connect\fP() function returns 0 on success or a negative error code on failure.
On success, the newly created connection object is stored in *conn_ptr whereas *req_ptr is
consumed and set to NULL. On failure, \fBrpma_conn_req_connect\fP() does not set *conn_ptr whereas
*req_ptr is consumed and set to NULL.
.SH ERRORS
\fBrpma_conn_req_connect\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - req_ptr, *req_ptr or conn_ptr is NULL
.IP \(bu 3
RPMA_E_INVAL - pdata is not NULL whereas pdata->len == 0
.IP \(bu 3
RPMA_E_NOMEM - out of memory
.IP \(bu 3
RPMA_E_PROVIDER - initiating a connection request failed (active side only)
.IP \(bu 3
RPMA_E_PROVIDER - accepting the connection request failed (passive side only)
.IP \(bu 3
RPMA_E_PROVIDER - freeing a communication event failed (passive side only)
.SH SEE ALSO
\fBrpma_conn_apply_remote_peer_cfg\fP(3), \fBrpma_conn_delete\fP(3), \fBrpma_conn_disconnect\fP(3),
\fBrpma_conn_get_cq\fP(3), \fBrpma_conn_get_event_fd\fP(3), \fBrpma_conn_get_private_data\fP(3),
\fBrpma_conn_get_rcq\fP(3), \fBrpma_conn_next_event\fP(3), \fBrpma_conn_req_new\fP(3), \fBrpma_ep_next_conn_req\fP(3),
\fBrpma_flush\fP(3), \fBrpma_read\fP(3), \fBrpma_recv\fP(3), \fBrpma_send\fP(3), \fBrpma_write\fP(3), \fBrpma_atomic_write\fP(3),
\fBlibrpma\fP(7) and https://pmem.io/rpma/