| Current File : //usr/share/man/man3/ibv_destroy_comp_channel.3 |
'\" te
.\" -*- nroff -*-
.\"
.TH IBV_CREATE_COMP_CHANNEL 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
.SH "NAME"
ibv_create_comp_channel, ibv_destroy_comp_channel \- create or
destroy a completion event channel
.SH "SYNOPSIS"
.nf
.B #include <infiniband/verbs.h>
.sp
.BI "struct ibv_comp_channel *ibv_create_comp_channel(struct ibv_context
.BI " " "*context" );
.sp
.BI "int ibv_destroy_comp_channel(struct ibv_comp_channel " "*channel" );
.fi
.SH "DESCRIPTION"
.B ibv_create_comp_channel()
creates a completion event channel for the InfiniBand device context
.I context\fR.
.PP
.B ibv_destroy_comp_channel()
destroys the completion event channel
.I channel\fR.
.SH "RETURN VALUE"
.B ibv_create_comp_channel()
returns a pointer to the created completion event channel, or NULL if the request fails.
.PP
.B ibv_destroy_comp_channel()
returns 0 on success, or the value of errno on failure (which indicates the failure reason).
.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE ATTRIBUTE VALUE
=
Availability network/open-fabrics
=
Stability Volatile
.TE
.PP
.SH "NOTES"
A "completion channel" is an abstraction introduced by libibverbs that
does not exist in the InfiniBand Architecture verbs specification or
RDMA Protocol Verbs Specification. A completion channel is
essentially file descriptor that is used to deliver completion
notifications to a userspace process. When a completion event is
generated for a completion queue (CQ), the event is delivered via the
completion channel attached to that CQ. This may be useful to steer
completion events to different threads by using multiple completion
channels.
.PP
.B ibv_destroy_comp_channel()
fails if any CQs are still associated with the completion event
channel being destroyed.
.SH "SEE ALSO"
.BR ibv_open_device (3),
.BR ibv_create_cq (3),
.BR ibv_get_cq_event (3)
.SH "AUTHORS"
.TP
Dotan Barak <dotanb@mellanox.co.il>
.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland. The original community source was downloaded from ['http://download.oracle.com/otn-pub/oss/networking/libsif-1.0.tar.gz', 'http://www.openfabrics.org/downloads/ibutils/ibutils-1.5.7.tar.gz', 'http://www.openfabrics.org/downloads/libibverbs/libibverbs-1.1.4-1.22.g7257cd3.tar.gz', 'http://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.1-1.18.gb810a27.tar.gz', 'http://www.openfabrics.org/downloads/libsdp/libsdp-1.1.108-0.15.gd7fdb72.tar.gz', 'http://www.openfabrics.org/downloads/management/infiniband-diags-1.5.8.tar.gz', 'http://www.openfabrics.org/downloads/management/libibmad-1.3.7.tar.gz', 'http://www.openfabrics.org/downloads/management/libibumad-1.3.7.tar.gz', 'http://www.openfabrics.org/downloads/management/opensm-3.3.9.tar.gz', 'http://www.openfabrics.org/downloads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'http://www.openfabrics.org/downloads/qperf/qperf-0.4.6-0.1.gb81434e.tar.gz', 'http://www.openfabrics.org/downloads/rdmacm/librdmacm-1.0.14.1.tar.gz', 'http://www.openfabrics.org/downloads/rds-tools/rds-tools-2.0.4.tar.gz']
Further information about this software can be found on the open source community website at http://www.openfabrics.org/.