| .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md |
| .TH "RDMA_DISCONNECT" 3 "2008-01-02" "librdmacm" "Librdmacm Programmer's Manual" librdmacm |
| .SH NAME |
| rdma_disconnect \- This function disconnects a connection. |
| .SH SYNOPSIS |
| .B "#include <rdma/rdma_cma.h>" |
| .P |
| .B "int" rdma_disconnect |
| .BI "(struct rdma_cm_id *" id ");" |
| .SH ARGUMENTS |
| .IP "id" 12 |
| RDMA identifier. |
| .SH "DESCRIPTION" |
| Disconnects a connection and transitions any associated QP to the error state, |
| which will flush any posted work requests to the completion queue. This |
| routine should be called by both the client and server side of a connection. |
| After successfully disconnecting, an RDMA_CM_EVENT_DISCONNECTED event will be |
| generated on both sides of the connection. |
| .SH "RETURN VALUE" |
| Returns 0 on success, or -1 on error. If an error occurs, errno will be |
| set to indicate the failure reason. |
| .SH "SEE ALSO" |
| rdma_connect(3), rdma_listen(3), rdma_accept(3), rdma_get_cm_event(3) |