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

      struct rpma_mr_remote;
      int \fBrpma_mr_remote_from_descriptor\fP(const void *desc, size_t desc_size,
                      struct rpma_mr_remote **mr_ptr);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
Create a remote memory region's structure based on the provided descriptor with
a network-transferable description of the memory region local to the remote peer.
.SH SECURITY WARNING
An attacker might modify the serialized remote memory registration configuration
while it is transferred via an unsecured connection (e.g. rdma_cm private data),
which might cause data corruption when writing to a different location.
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_mr_remote_from_descriptor\fP() function returns 0 on success or a negative error code on
failure. \fBrpma_mr_remote_from_descriptor\fP() does not set *mr_ptr value on failure.
.SH ERRORS
\fBrpma_mr_remote_from_descriptor\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - desc or mr_ptr is NULL
.IP \(bu 3
RPMA_E_INVAL - incompatible descriptor size
.IP \(bu 3
RPMA_E_NOSUPP - deserialized information does not represent a valid memory region
.IP \(bu 3
RPMA_E_NOMEM - out of memory
.SH SEE ALSO
\fBrpma_mr_remote_delete\fP(3), \fBrpma_mr_remote_get_flush_type\fP(3), \fBrpma_mr_remote_get_size\fP(3),
\fBrpma_flush\fP(3), \fBrpma_read\fP(3), \fBrpma_write\fP(3), \fBrpma_atomic_write\fP(3), \fBlibrpma\fP(7) and
https://pmem.io/rpma/