contrib/ofed/librdmacm/man/rdma_get_devices.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_GET_DEVICES" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_get_devices \- Get a list of RDMA devices currently available.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "struct ibv_context **" rdma_get_devices
   9 .BI "(int *" num_devices ");"
  10 .SH ARGUMENTS
  11 .IP "num_devices" 12
  12 If non-NULL, set to the number of devices returned.
  13 .SH "DESCRIPTION"
  14 Return a NULL-terminated array of opened RDMA devices.  Callers can use
  15 this routine to allocate resources on specific RDMA devices that will be
  16 shared across multiple rdma_cm_id's.
  17 .SH "RETURN VALUE"
  18 Returns an array of available RDMA devices, or NULL if the request
  19 fails.  On failure, errno will be set to indicate the failure reason.
  20 .SH "NOTES"
  21 The returned array must be released by calling rdma_free_devices.  Devices
  22 remain opened while the librdmacm is loaded.
  23 .SH "SEE ALSO"
  24 rdma_free_devices(3)