librpma API version 0.10.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_rcq_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_rcq_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_cq.3 rpma_conn_get_event_fd.3 rpma_conn_get_private_data.3 rpma_conn_get_qp_num.3 rpma_conn_get_rcq.3 rpma_conn_next_event.3 rpma_conn_req_connect.3 rpma_conn_req_delete.3 rpma_conn_req_get_private_data.3 rpma_conn_req_new.3 rpma_conn_req_recv.3 rpma_cq_get_completion.3 rpma_cq_get_fd.3 rpma_cq_wait.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_advise.3 rpma_mr_dereg.3 rpma_mr_get_descriptor.3 rpma_mr_get_descriptor_size.3 rpma_mr_get_ptr.3 rpma_mr_get_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_send_with_imm.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 rpma_write_with_imm.3

NAME

rpma_conn_get_completion_fd - get the completion file descriptor (deprecated)

SYNOPSIS

      #include <librpma.h>

      struct rpma_conn;
      int rpma_conn_get_completion_fd(const struct rpma_conn *conn, int *fd);

DESCRIPTION

rpma_conn_get_completion_fd() gets the completion file descriptor of the connection. It is the same file descriptor as the one returned by the rpma_cq_get_fd(3) for the connection's main CQ available via rpma_conn_get_cq(3).

RETURN VALUE

The rpma_conn_get_completion_fd() function returns 0 on success or a negative error code on failure. rpma_conn_get_completion_fd() does not set *fd value on failure.

ERRORS

rpma_conn_get_completion_fd() can fail with the following error:

  • RPMA_E_INVAL - conn or fd is NULL

DEPRECATED

Please use rpma_conn_get_cq(3) and rpma_cq_get_fd(3) instead. This is an example snippet of code using the old API:

        int ret;
        int fd;

        ret = rpma_conn_get_completion_fd(conn, &fd);
        if (ret) { error_handling_code() }

        ret = rpma_conn_completion_wait(conn);
        if (ret) { error_handling_code() }

        struct rpma_completion cmpl;
        ret = rpma_conn_completion_get(conn, &cmpl);
        if (ret) { error_handling_code() }

The above snippet should be replaced with the following one using the new API:

        rpma_cq *cq;
        if (rpma_conn_get_cq(conn, &cq)) { error_handling_code() }

        ret = rpma_cq_get_fd(cq, &fd);
        if (ret) { error_handling_code() }

        ret = rpma_cq_wait(cq);
        if (ret) { error_handling_code() }

        struct rpma_completion cmpl;

        ret = rpma_cq_get_completion(cq, &cmpl);
        if (ret) { error_handling_code() }

SEE ALSO

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

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