contrib/ofed/libibverbs/man/ibv_create_comp_channel.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_CREATE_COMP_CHANNEL 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_create_comp_channel, ibv_destroy_comp_channel \- create or
   6 destroy a completion event channel
   7 .SH "SYNOPSIS"
   8 .nf
   9 .B #include <infiniband/verbs.h>
  10 .sp
  11 .BI "struct ibv_comp_channel *ibv_create_comp_channel(struct ibv_context
  12 .BI "                                                 " "*context" );
  13 .sp
  14 .BI "int ibv_destroy_comp_channel(struct ibv_comp_channel " "*channel" );
  15 .fi
  16 .SH "DESCRIPTION"
  17 .B ibv_create_comp_channel()
  18 creates a completion event channel for the RDMA device context
  19 .I context\fR.
  20 .PP
  21 .B ibv_destroy_comp_channel()
  22 destroys the completion event channel
  23 .I channel\fR.
  24 .SH "RETURN VALUE"
  25 .B ibv_create_comp_channel()
  26 returns a pointer to the created completion event channel, or NULL if the request fails.
  27 .PP
  28 .B ibv_destroy_comp_channel()
  29 returns 0 on success, or the value of errno on failure (which indicates the failure reason).
  30 .SH "NOTES"
  31 A "completion channel" is an abstraction introduced by libibverbs that
  32 does not exist in the InfiniBand Architecture verbs specification or
  33 RDMA Protocol Verbs Specification.  A completion channel is
  34 essentially file descriptor that is used to deliver completion
  35 notifications to a userspace process.  When a completion event is
  36 generated for a completion queue (CQ), the event is delivered via the
  37 completion channel attached to that CQ.  This may be useful to steer
  38 completion events to different threads by using multiple completion
  39 channels.
  40 .PP
  41 .B ibv_destroy_comp_channel()
  42 fails if any CQs are still associated with the completion event
  43 channel being destroyed.
  44 .SH "SEE ALSO"
  45 .BR ibv_open_device (3),
  46 .BR ibv_create_cq (3),
  47 .BR ibv_get_cq_event (3)
  48 .SH "AUTHORS"
  49 .TP
  50 Dotan Barak <dotanb@mellanox.co.il>