contrib/ofed/librdmacm/man/rdma_resolve_route.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_RESOLVE_ROUTE" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_resolve_route \- Resolve the route information needed to establish a connection.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_resolve_route
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "int " timeout_ms ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 RDMA identifier.
  14 .IP "timeout_ms" 12
  15 Time to wait for resolution to complete.
  16 .SH "DESCRIPTION"
  17 Resolves an RDMA route to the destination address in order to establish
  18 a connection.  The destination address must have already been resolved
  19 by calling rdma_resolve_addr.
  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 This is called on the client side of a connection after calling
  25 rdma_resolve_addr, but before calling rdma_connect.
  26 .SH "INFINIBAND SPECIFIC"
  27 This call obtains a path record that is used by the connection.
  28 .SH "SEE ALSO"
  29 rdma_resolve_addr(3), rdma_connect(3), rdma_get_cm_event(3)