contrib/ofed/librdmacm/man/rdma_get_request.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_GET_REQUEST" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_get_request \- Retrieves the next pending connection request event.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_get_request
   9 .BI "(struct rdma_cm_id *" listen ","
  10 .BI "struct rdma_cm_id **" id ");"
  11 .SH ARGUMENTS
  12 .IP "listen" 12
  13 Listening rdma_cm_id.
  14 .IP "id" 12
  15 rdma_cm_id associated with the new connection.
  16 .SH "DESCRIPTION"
  17 Retrieves a connection request event.  If no requests are pending,
  18 the call will block until an event is received.
  19 .SH "RETURN VALUE"
  20 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  21 set to indicate the failure reason.
  22 .SH "NOTES"
  23 This call may only be used on listening rdma_cm_id's operating
  24 synchronously.  On success, a new rdma_cm_id representing the
  25 connection request will be returned to the user.  The new rdma_cm_id
  26 will reference event information associated with the request until
  27 the user calls rdma_reject, rdma_accept, or rdma_destroy_id on the
  28 newly created identifier.  For a description of the event data,
  29 see rdma_get_cm_event.
  30 .P
  31 If QP attributes are associated with the listening endpoint, the
  32 returned rdma_cm_id will also reference an allocated QP.
  33 .SH "SEE ALSO"
  34 rdma_get_cm_event(3), rdma_accept(3), rdma_reject(3),
  35 rdma_connect(3), rdma_listen(3), rdma_destroy_id(3)