contrib/ofed/librdmacm/man/rdma_destroy_id.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_DESTROY_ID" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_destroy_id \- Release a communication identifier.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_destroy_id
   9 .BI "(struct rdma_cm_id *" id ");"
  10 .SH ARGUMENTS
  11 .IP "id" 12
  12 The communication identifier to destroy.
  13 .SH "DESCRIPTION"
  14 Destroys the specified rdma_cm_id and cancels any outstanding
  15 asynchronous operation.
  16 .SH "RETURN VALUE"
  17 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  18 set to indicate the failure reason.
  19 .SH "NOTES"
  20 Users must free any associated QP with the rdma_cm_id before
  21 calling this routine and ack all related events.
  22 .SH "SEE ALSO"
  23 rdma_create_id(3), rdma_destroy_qp(3), rdma_ack_cm_event(3)