contrib/ofed/librdmacm/man/rdma_connect.3

   1 .TH "RDMA_CONNECT" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   2 .SH NAME
   3 rdma_connect \- Initiate an active connection request.
   4 .SH SYNOPSIS
   5 .B "#include <rdma/rdma_cma.h>"
   6 .P
   7 .B "int" rdma_connect
   8 .BI "(struct rdma_cm_id *" id ","
   9 .BI "struct rdma_conn_param *" conn_param ");"
  10 .SH ARGUMENTS
  11 .IP "id" 12
  12 RDMA identifier.
  13 .IP "conn_param" 12
  14 connection parameters.  See CONNECTION PROPERTIES below for details.
  15 .SH "DESCRIPTION"
  16 For an rdma_cm_id of type RDMA_PS_TCP, this call initiates a connection request
  17 to a remote destination.  For an rdma_cm_id of type RDMA_PS_UDP, it initiates
  18 a lookup of the remote QP providing the datagram service.
  19 .SH "NOTES"
  20 Users must have resolved a route to the destination address
  21 by having called rdma_resolve_route before calling this routine.
  22 .SH "CONNECTION PROPERTIES"
  23 The following properties are used to configure the communication and specified
  24 by the conn_param parameter when connecting or establishing datagram
  25 communication.
  26 .IP private_data
  27 References a user-controlled data buffer.  The contents of the buffer are
  28 copied and transparently passed to the remote side as part of the
  29 communication request.  May be NULL if private_data is not required.
  30 .IP private_data_len
  31 Specifies the size of the user-controlled data buffer.  Note that the actual
  32 amount of data transferred to the remote side is transport dependent and may
  33 be larger than that requested.
  34 .IP responder_resources
  35 The maximum number of outstanding RDMA read and atomic operations that the
  36 local side will accept from the remote side.  Applies only to RDMA_PS_TCP.
  37 This value must be less than or equal to the local RDMA device attribute
  38 max_qp_rd_atom and remote RDMA device attribute max_qp_init_rd_atom.  The
  39 remote endpoint can adjust this value when accepting the connection.
  40 .IP initiator_depth
  41 The maximum number of outstanding RDMA read and atomic operations that the
  42 local side will have to the remote side.  Applies only to RDMA_PS_TCP.
  43 This value must be less than or equal to the local RDMA device attribute
  44 max_qp_init_rd_atom and remote RDMA device attribute max_qp_rd_atom.  The
  45 remote endpoint can adjust this value when accepting the connection.
  46 .IP flow_control
  47 Specifies if hardware flow control is available.  This value is exchanged
  48 with the remote peer and is not used to configure the QP.  Applies only to
  49 RDMA_PS_TCP.
  50 .IP retry_count
  51 The maximum number of times that a data transfer operation should be retried
  52 on the connection when an error occurs.  This setting controls the number of
  53 times to retry send, RDMA, and atomic operations when timeouts occur.
  54 Applies only to RDMA_PS_TCP.
  55 .IP rnr_retry_count
  56 The maximum number of times that a send operation from the remote peer
  57 should be retried on a connection after receiving a receiver not ready (RNR)
  58 error.  RNR errors are generated when a send request arrives before a buffer
  59 has been posted to receive the incoming data.  Applies only to RDMA_PS_TCP.
  60 .IP srq
  61 Specifies if the QP associated with the connection is using a shared receive
  62 queue.  This field is ignored by the library if a QP has been created on the
  63 rdma_cm_id.  Applies only to RDMA_PS_TCP.
  64 .IP qp_num
  65 Specifies the QP number associated with the connection.  This field is ignored
  66 by the library if a QP has been created on the rdma_cm_id.  Applies only to
  67 RDMA_PS_TCP.
  68 .SH "INFINIBAND SPECIFIC"
  69 In addition to the connection properties defined above, InfiniBand QPs are
  70 configured with minimum RNR NAK timer and local ACK timeout values.  The
  71 minimum RNR NAK timer value is set to 0, for a delay of 655 ms.
  72 The local ACK timeout is calculated based on the packet lifetime and local
  73 HCA ACK delay.  The packet lifetime is determined by the InfiniBand Subnet
  74 Administrator and is part of the resolved route (path record) information.
  75 The HCA ACK delay is a property of the locally used HCA.
  76 .P
  77 Retry count and RNR retry count values are 3-bit values.
  78 .SH "IWARP SPECIFIC"
  79 Connections established over iWarp RDMA devices currently require that the
  80 active side of the connection send the first message.
  81 .SH "SEE ALSO"
  82 rdma_cm(7), rdma_create_id(3), rdma_resolve_route(3), rdma_disconnect(3),
  83 rdma_listen(3), rdma_get_cm_event(3)