contrib/ofed/librdmacm/man/rdma_bind_addr.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_BIND_ADDR" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_bind_addr \- Bind an RDMA identifier to a source address.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_bind_addr
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct sockaddr *" addr ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 RDMA identifier.
  14 .IP "addr" 12
  15 Local address information.  Wildcard values are permitted.
  16 .SH "DESCRIPTION"
  17 Associates a source address with an rdma_cm_id.  The address may be
  18 wildcarded.  If binding to a specific local address, the rdma_cm_id
  19 will also be bound to a local RDMA device.
  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 Typically, this routine is called before calling rdma_listen to bind
  25 to a specific port number, but it may also be called on the active side
  26 of a connection before calling rdma_resolve_addr to bind to a specific
  27 address.
  28 .P
  29 If used to bind to port 0, the rdma_cm will select an available port,
  30 which can be retrieved with rdma_get_src_port(3).
  31 .SH "SEE ALSO"
  32 rdma_create_id(3), rdma_listen(3), rdma_resolve_addr(3), rdma_create_qp(3),
  33 rdma_get_local_addr(3), rdma_get_src_port(3)