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_peer_delete - delete a peer object

SYNOPSIS

      #include <librpma.h>

      struct rpma_peer;
      int rpma_peer_delete(struct rpma_peer **peer_ptr);

DESCRIPTION

rpma_peer_delete() deletes the peer object.

RETURN VALUE

The rpma_peer_delete() function returns 0 on success or a negative error code on failure. rpm_peer_delete() does not set *peer_ptr value to NULL on failure.

RETURN VALUE

The rpma_peer_delete() function returns 0 on success or a negative error code on failure. rpma_peer_delete() does not set *peer_ptr to NULL on failure.

ERRORS

rpma_peer_delete() can fail with the following error:

• RPMA_E_PROVIDER - deleting the verbs protection domain failed.

SEE ALSO

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