contrib/ofed/librdmacm/man/rdma_listen.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_LISTEN" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_listen \- Listen for incoming connection requests.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_listen
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "int " backlog ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 RDMA identifier.
  14 .IP "backlog" 12
  15 backlog of incoming connection requests.
  16 .SH "DESCRIPTION"
  17 Initiates a listen for incoming connection requests or datagram service
  18 lookup.  The listen will be restricted to the locally bound source
  19 address.
  20 .SH "RETURN VALUE"
  21 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  22 set to indicate the failure reason.
  23 .SH "NOTES"
  24 Users must have bound the rdma_cm_id to a local address by calling
  25 rdma_bind_addr before calling this routine.  If the rdma_cm_id is
  26 bound to a specific IP address, the listen will be restricted to that
  27 address and the associated RDMA device.  If the rdma_cm_id is bound
  28 to an RDMA port number only, the listen will occur across all RDMA
  29 devices.
  30 .SH "SEE ALSO"
  31 rdma_cm(7), rdma_bind_addr(3), rdma_connect(3), rdma_accept(3), rdma_reject(3),
  32 rdma_get_cm_event(3)