Scroll to navigation

rpma_recv(3) RPMA Programmer's Manual rpma_recv(3)

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_conn_completion_get(3).

The attribute flags set the completion notification indicator:

  • RPMA_F_COMPLETION_ON_ERROR - generate the completion on error
  • RPMA_F_COMPLETION_ALWAYS - generate the completion regardless of result of the operation

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 or src is NULL
  • 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/
21 October 2020 RPMA