librpma API version 0.9.0

librpma.7 rpma_conn_apply_remote_peer_cfg.3 rpma_conn_cfg_delete.3 rpma_conn_cfg_get_cq_size.3 rpma_conn_cfg_get_rq_size.3 rpma_conn_cfg_get_sq_size.3 rpma_conn_cfg_get_timeout.3 rpma_conn_cfg_new.3 rpma_conn_cfg_set_cq_size.3 rpma_conn_cfg_set_rq_size.3 rpma_conn_cfg_set_sq_size.3 rpma_conn_cfg_set_timeout.3 rpma_conn_completion_get.3 rpma_conn_completion_wait.3 rpma_conn_delete.3 rpma_conn_disconnect.3 rpma_conn_get_completion_fd.3 rpma_conn_get_event_fd.3 rpma_conn_get_private_data.3 rpma_conn_next_event.3 rpma_conn_req_connect.3 rpma_conn_req_delete.3 rpma_conn_req_new.3 rpma_conn_req_recv.3 rpma_ep_get_fd.3 rpma_ep_listen.3 rpma_ep_next_conn_req.3 rpma_ep_shutdown.3 rpma_err_2str.3 rpma_flush.3 rpma_log_get_threshold.3 rpma_log_set_function.3 rpma_log_set_threshold.3 rpma_mr_dereg.3 rpma_mr_get_descriptor.3 rpma_mr_get_descriptor_size.3 rpma_mr_reg.3 rpma_mr_remote_delete.3 rpma_mr_remote_from_descriptor.3 rpma_mr_remote_get_flush_type.3 rpma_mr_remote_get_size.3 rpma_peer_cfg_delete.3 rpma_peer_cfg_from_descriptor.3 rpma_peer_cfg_get_descriptor.3 rpma_peer_cfg_get_descriptor_size.3 rpma_peer_cfg_get_direct_write_to_pmem.3 rpma_peer_cfg_new.3 rpma_peer_cfg_set_direct_write_to_pmem.3 rpma_peer_delete.3 rpma_peer_new.3 rpma_read.3 rpma_recv.3 rpma_send.3 rpma_utils_conn_event_2str.3 rpma_utils_get_ibv_context.3 rpma_utils_ibv_context_is_odp_capable.3 rpma_write.3 rpma_write_atomic.3

NAME

rpma_conn_completion_get - receive a completion of an operation

SYNOPSIS

      #include <librpma.h>

      struct rpma_conn;
      struct rpma_completion;
      enum rpma_op {
              RPMA_OP_READ,
              RPMA_OP_WRITE,
              RPMA_OP_FLUSH,
              RPMA_OP_SEND,
              RPMA_OP_RECV,
      };

      int rpma_conn_completion_get(struct rpma_conn *conn,
                      struct rpma_completion *cmpl);

DESCRIPTION

rpma_conn_completion_get() receives the next available completion of an already posted operation. All operations generate completion on error. The operations posted with the **RPMA_F_COMPLETION_ALWAYS** flag also generate a completion on success. The following operations are available:

  • RPMA_OP_READ - RMA read operation

  • RPMA_OP_WRITE - RMA write operation

  • RPMA_OP_FLUSH - RMA flush operation

  • RPMA_OP_SEND - messaging send operation

  • RPMA_OP_RECV - messaging receive operation

RETURN VALUE

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

ERRORS

rpma_conn_completion_get() can fail with the following errors:

  • RPMA_E_INVAL - conn or cmpl is NULL

  • RPMA_E_NO_COMPLETION - no completions available

  • RPMA_E_PROVIDER - ibv_poll_cq(3) failed with a provider error

  • RPMA_E_UNKNOWN - ibv_poll_cq(3) failed but no provider error is available

  • RPMA_E_NOSUPP - not supported opcode

SEE ALSO

rpma_conn_get_completion_fd(3), rpma_conn_completion_wait(3), rpma_conn_req_connect(3), rpma_flush(3), rpma_read(3), rpma_recv(3), rpma_send(3), rpma_write(3), rpma_write_atomic(3), librpma(7) and https://pmem.io/rpma/

The contents of this web site and the associated GitHub repositories are BSD-licensed open source.