contrib/ofed/librdmacm/man/rdma_create_event_channel.3

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