.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "RDMA_GET_REMOTE_ECE" "3" "2020-02-02" "librdmacm" "Librdmacm Programmer\[cq]s Manual"
.hy
.SH NAME
.PP
rdma_get_remote_ece - Get remote ECE paraemters as received from the
peer.
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <rdma/rdma_cma.h>

int rdma_get_remote_ece(struct rdma_cm_id *id, struct ibv_ece *ece);
\f[R]
.fi
.SH DESCRIPTION
.PP
\f[B]rdma_get_remote_ece()\f[R] get ECE parameters as were received from
the communication peer.
.PP
This function is suppose to be used by the users of external QPs.
The call needs to be performed before replying to the peer and needed to
allow for the passive side to know ECE options of other side.
.PP
Being used by external QP and RDMA_CM doesn\[cq]t manage that QP, the
peer needs to call to libibverbs API by itself.
.PP
Usual flow for the passive side will be:
.IP \[bu] 2
ibv_create_qp() <- create data QP.
.IP \[bu] 2
ece = rdma_get_remote_ece() <- get ECE options from remote peer
.IP \[bu] 2
ibv_set_ece(ece) <- set local ECE options with data received from the
peer.
.IP \[bu] 2
ibv_modify_qp() <- enable data QP.
.IP \[bu] 2
rdma_set_local_ece(ece) <- set desired ECE options after respective
libibverbs provider masked unsupported options.
.IP \[bu] 2
rdma_accept()/rdma_establish()/rdma_reject_ece()
.SH ARGUMENTS
.TP
*id
RDMA communication identifier.
.TP
*ece
ECE struct to be filled.
.SH RETURN VALUE
.PP
\f[B]rdma_get_remote_ece()\f[R] returns 0 on success, or -1 on error.
If an error occurs, errno will be set to indicate the failure reason.
.SH SEE ALSO
.PP
\f[B]rdma_cm\f[R](7), rdma_set_local_ece(3)
.SH AUTHOR
.PP
Leon Romanovsky <leonro@mellanox.com>