contrib/ofed/librdmacm/man/rdma_destroy_event_channel.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_DESTROY_EVENT_CHANNEL" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_destroy_event_channel \- Close an event communication channel.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "void" rdma_destroy_event_channel
   9 .BI "(struct rdma_event_channel *" channel ");"
  10 .SH ARGUMENTS
  11 .IP "channel" 12
  12 The communication channel to destroy.
  13 .SH "DESCRIPTION"
  14 Release all resources associated with an event channel and closes the
  15 associated file descriptor.
  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 All rdma_cm_id's associated with the event channel must be destroyed,
  21 and all returned events must be acked before calling this function.
  22 .SH "SEE ALSO"
  23 rdma_create_event_channel(3), rdma_get_cm_event(3), rdma_ack_cm_event(3)