.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_peer_cfg_from_descriptor 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_peer_cfg_from_descriptor \fP- create a peer cfg from the descriptor
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_peer_cfg;
      int \fBrpma_peer_cfg_from_descriptor\fP(const void *desc, size_t desc_size,
                      struct rpma_peer_cfg **pcfg_ptr);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_peer_cfg_from_descriptor\fP() creates a peer configuration object from the descriptor.
.SH SECURITY WARNING
An attacker might modify the serialized remote node configuration while it is transferred
via an unsecured connection (e.g. rdma_cm private data), which might cause
different remote persistency method selections. The most dangerous situation is switching
from the GPSPM mode to the APM one. Users should avoid using \fBrpma_conn_get_private_data\fP(3)
and \fBrpma_conn_req_get_private_data\fP(3) API calls and they should utilize TLS/SSL connections
to transfer all configuration data between peers instead.
.SH RETURN VALUE
The \fBrpma_peer_cfg_from_descriptor\fP() function returns 0 on success or a negative error code on
failure. \fBrpma_peer_cfg_from_descriptor\fP() does not set *pcfg_ptr value on failure.
.SH ERRORS
\fBrpma_peer_cfg_from_descriptor\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - desc or pcfg_ptr are NULL
.IP \(bu 3
RPMA_E_NOMEM - out of memory
.SH SEE ALSO
\fBrpma_conn_apply_remote_peer_cfg\fP(3), \fBrpma_peer_cfg_get_descriptor\fP(3), \fBrpma_peer_cfg_new\fP(3),
\fBlibrpma\fP(7) and https://pmem.io/rpma/