contrib/ofed/librdmacm/man/rdma_create_event_channel.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_CREATE_EVENT_CHANNEL" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_create_event_channel \- Open a channel used to report communication events.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "struct rdma_event_channel *" rdma_create_event_channel
   9 .BI "(" void ");"
  10 .SH ARGUMENTS
  11 .IP "void" 12
  12 no arguments
  13 .SH "DESCRIPTION"
  14 Asynchronous events are reported to users through event channels.
  15 .SH "RETURN VALUE"
  16 Returns a pointer to the created event channel, or NULL if the request
  17 fails.  On failure, errno will be set to indicate the failure reason.
  18 .SH "NOTES"
  19 Event channels are used to direct all events on an rdma_cm_id.  For many
  20 clients, a single event channel may be sufficient, however, when managing
  21 a large number of connections or cm_id's, users may find it useful to direct
  22 events for different cm_id's to different channels for processing.
  23 .P
  24 All created event channels must be destroyed by calling
  25 rdma_destroy_event_channel.  Users should call rdma_get_cm_event to
  26 retrieve events on an event channel.
  27 .P
  28 Each event channel is mapped to a file descriptor.  The associated file
  29 descriptor can be used and manipulated like any other fd to change its
  30 behavior.  Users may make the fd non-blocking, poll or select the fd, etc.
  31 .SH "SEE ALSO"
  32 rdma_cm(7), rdma_get_cm_event(3), rdma_destroy_event_channel(3)