NAME

       rpma_recv - initiate the receive operation

SYNOPSIS

             #include <librpma.h>

             struct rpma_conn;
             struct rpma_mr_local;
             int rpma_recv(struct rpma_conn *conn, struct rpma_mr_local *dst, size_t offset, size_t len,
                             const void *op_context);

DESCRIPTION

       rpma_recv() initiates the receive operation which prepares a buffer for a message sent from other side of
       the connection. Please see rpma_send(3).

       All  buffers  prepared via rpma_recv(3) form an unordered set. When a message arrives it is placed in one
       of the buffers awaitaning and a completion for the receive operation is generated.

       A buffer for an incoming message have to be prepared beforehand.

       The order of buffers in the set does not affect the order of completions of receive  operations  get  via
       rpma_cq_get_wc(3).

       op_context is returned in the wr_id field of the completion (struct ibv_wc).

NOTE

       In the RDMA standard, receive requests form an ordered queue.  The RPMA does NOT inherit this guarantee.

RETURN VALUE

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

ERRORS

       rpma_recv() can fail with the following errors:

       •  RPMA_E_INVAL - conn == NULL

       •  RPMA_E_INVAL - dst == NULL && (offset != 0 || len != 0)

       •  RPMA_E_PROVIDER - ibv_post_recv(3) failed

SEE ALSO

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

RPMA                                              01 April 2024                                     rpma_recv(3)