contrib/ofed/librdmacm/man/rdma_accept.3

   1 .TH "RDMA_ACCEPT" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   2 .SH NAME
   3 rdma_accept \- Called to accept a connection request.
   4 .SH SYNOPSIS
   5 .B "#include <rdma/rdma_cma.h>"
   6 .P
   7 .B "int" rdma_accept
   8 .BI "(struct rdma_cm_id *" id ","
   9 .BI "struct rdma_conn_param *" conn_param ");"
  10 .SH ARGUMENTS
  11 .IP "id" 12
  12 Connection identifier associated with the request.
  13 .IP "conn_param" 12
  14 Information needed to establish the connection.  See CONNECTION PROPERTIES
  15 below for details.
  16 .SH "DESCRIPTION"
  17 Called from the listening side to accept a connection or datagram
  18 service lookup request.
  19 .SH "NOTES"
  20 Unlike the socket accept routine, rdma_accept is not called on a
  21 listening rdma_cm_id.  Instead, after calling rdma_listen, the user
  22 waits for an RDMA_CM_EVENT_CONNECT_REQUEST event to occur.  Connection request
  23 events give the user a newly created rdma_cm_id, similar to a new
  24 socket, but the rdma_cm_id is bound to a specific RDMA device.
  25 rdma_accept is called on the new rdma_cm_id.
  26 .SH "CONNECTION PROPERTIES"
  27 The following properties are used to configure the communication and specified
  28 by the conn_param parameter when accepting a connection or datagram
  29 communication request.  Users should use the rdma_conn_param values reported
  30 in the connection request event to determine appropriate values for these
  31 fields when accepting.  Users may reference the rdma_conn_param structure in
  32 the connection event directly, or can reference their own structure.  If the
  33 rdma_conn_param structure from an event is referenced, the event must not be
  34 acked until after this call returns.
  35 .IP private_data
  36 References a user-controlled data buffer.  The contents of the buffer are
  37 copied and transparently passed to the remote side as part of the
  38 communication request.  May be NULL if private_data is not required.
  39 .IP private_data_len
  40 Specifies the size of the user-controlled data buffer.  Note that the actual
  41 amount of data transferred to the remote side is transport dependent and may
  42 be larger than that requested.
  43 .IP responder_resources
  44 The maximum number of outstanding RDMA read and atomic operations that the
  45 local side will accept from the remote side.  Applies only to RDMA_PS_TCP.
  46 This value must be less than or equal to the local RDMA device attribute
  47 max_qp_rd_atom and the responder_resources value reported in the connect
  48 request event.
  49 .IP initiator_depth
  50 The maximum number of outstanding RDMA read and atomic operations that the
  51 local side will have to the remote side.  Applies only to RDMA_PS_TCP.
  52 This value must be less than or equal to the local RDMA device attribute
  53 max_qp_init_rd_atom and the initiator_depth value reported in the connect
  54 request event.
  55 .IP flow_control
  56 Specifies if hardware flow control is available.  This value is exchanged
  57 with the remote peer and is not used to configure the QP.  Applies only to
  58 RDMA_PS_TCP.
  59 .IP retry_count
  60 This value is ignored.
  61 .IP rnr_retry_count
  62 The maximum number of times that a send operation from the remote peer
  63 should be retried on a connection after receiving a receiver not ready (RNR)
  64 error.  RNR errors are generated when a send request arrives before a buffer
  65 has been posted to receive the incoming data.  Applies only to RDMA_PS_TCP.
  66 .IP srq
  67 Specifies if the QP associated with the connection is using a shared receive
  68 queue.  This field is ignored by the library if a QP has been created on the
  69 rdma_cm_id.  Applies only to RDMA_PS_TCP.
  70 .IP qp_num
  71 Specifies the QP number associated with the connection.  This field is ignored
  72 by the library if a QP has been created on the rdma_cm_id.
  73 .SH "INFINIBAND SPECIFIC"
  74 In addition to the connection properties defined above, InfiniBand QPs are
  75 configured with minimum RNR NAK timer and local ACK timeout values.  The
  76 minimum RNR NAK timer value is set to 0, for a delay of 655 ms.
  77 The local ACK timeout is calculated based on the packet lifetime and local
  78 HCA ACK delay.  The packet lifetime is determined by the InfiniBand Subnet
  79 Administrator and is part of the route (path record) information obtained
  80 by the active side of the connection.  The HCA ACK delay is a property of
  81 the locally used HCA.
  82 .P
  83 The RNR retry count is a 3-bit value.
  84 .SH "SEE ALSO"
  85 rdma_listen(3), rdma_reject(3), rdma_get_cm_event(3)