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

      struct rpma_conn;
      int \fBrpma_conn_disconnect\fP(struct rpma_conn *conn);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_conn_disconnect\fP() tears the connection down.
.IP \(bu 3
It may initiate disconnecting the connection. In this case, the end of disconnecting is
signalled by the RPMA_CONN_CLOSED event via \fBrpma_conn_next_event\fP() or
.IP \(bu 3
It may be called after receiving the RPMA_CONN_CLOSED event. In this case, the disconnection
is done when \fBrpma_conn_disconnect\fP() returns with success.
.SH RETURN VALUE
The \fBrpma_conn_disconnect\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_conn_disconnect\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - conn is NULL
.IP \(bu 3
RPMA_E_PROVIDER - \fBrdma_disconnect\fP() failed
.SH SEE ALSO
\fBrpma_conn_delete\fP(3), \fBrpma_conn_next_event\fP(3), \fBrpma_conn_req_connect\fP(3), \fBlibrpma\fP(7) and
https://pmem.io/rpma/