NAME¶

rpma_mr_get_descriptor - get a descriptor of a memory region

SYNOPSIS¶

      #include <librpma.h>


      struct rpma_mr_local;


      int rpma_mr_get_descriptor(const struct rpma_mr_local *mr, void *desc);

DESCRIPTION¶

rpma_mr_get_descriptor() writes a network-transferable description of the provided local memory region (called 'descriptor'). Once the descriptor is transferred to the other side it should be decoded by rpma_mr_remote_from_descriptor() to create a remote memory region's structure which allows for Remote Memory Access. Please see librpma(7) for details.

SECURITY WARNING¶

See rpma_mr_remote_from_descriptor(3).

RETURN VALUE¶

The rpma_mr_get_descriptor() function returns 0 on success or a negative error code on failure.

ERRORS¶

rpma_mr_get_descriptor() can fail with the following error:

•

RPMA_E_INVAL - mr or desc is NULL

SEE ALSO¶

rpma_mr_get_descriptor_size(3), rpma_mr_reg(3), librpma(7) and https://pmem.io/rpma/