contrib/ofed/librdmacm/man/rdma_disconnect.3

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